docs(get-started): Updates "about PatternFly" page. #3930

edonehoo · 2024-03-22T13:36:04Z

Closes #3897

edonehoo · 2024-03-22T13:40:54Z

bunch of notes/q's:

merged the "community" page into the main "about patternfly" page, which aligns with some of the feedback from our user research. does it work? is too much lost/cut out in this move?
I POC'd a bunch of cards (which are looking funky right now) to try and present info differently
- as part of this ^ I kind of organized the major parts of PF into "categories", which I'm curious for thoughts on. Does the grouping make sense? The naming? Another research result is that we should consider grouping the left nav into sections, which (if we go forward with that) I'd like to match the organization in this page, so want to be sure it makes sense
Longer term, this page would benefit from more images (per user feedback), but not sure where to start with that. Maybe we could make the cards a split design of some kind idk. Sounds like followup if there's bandwidth

patternfly-build · 2024-03-22T13:47:10Z

Preview: https://patternfly-org-pr-3930-site.surge.sh

andrew-ronaldson

Just a couple nits.

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

packages/documentation-site/package.json

srambach · 2024-04-18T14:20:06Z

I like the cards. I'm a little confused by the about.md and about-PatternFly.md both? They seem to be the same or very similar?
Also I do feel like some things were cut that are important - like release cadence and beta features?

edonehoo · 2024-04-29T17:03:59Z

@srambach ty for the feedback!!

I added about-patternfly.md to replace about.md, since the page name changed to "about patternfly". Meant to delete about.md! Just did that, but lmk if you see any issues
Release cadence:

I repurposed some of this info under "how do I stay up to date", but maybe that heading isn't very clear? I swapped back to "release cadence". I also added back the info I left off regarding "React next".
I think, long term, the React next info could be moved (I'll mention this below)

Beta components:

I did remove this info, but I just added it back for now!
I also think that this info could move somewhere better in the future (below)

I've talked to Andrew about this idea some, but I think there's a good opportunity to create an "all components" kind of doc on org (as proposed in patternfly/patternfly-design#1301). This would be a place where we could add higher level component docs (like information about beta components and deprecated components) so that they're more and juxtaposed by the component docs. I think numbers 2 and 3 above could both be moved into that new area, if/when it does come to fruition. But, if they need to be moved in the future, that can be handled in a separate pr!

edonehoo · 2024-05-08T19:39:15Z

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

+<Grid sm={12} md={4} hasGutter>
+<Button size="lg" variant="secondary" component="a" href="/get-started/design"> Start designing </Button>
+<Button size="lg" variant="secondary" component="a" href="/get-started/develop"> Start developing </Button>
+<Button size="lg" variant="secondary" component="a" href="/get-started/contribute/contributing-to-patternfly"> Contribute to PatternFly</Button>


Suggested change

<Button size="lg" variant="secondary" component="a" href="/get-started/contribute/contributing-to-patternfly"> Contribute to PatternFly</Button>

<Button size="lg" variant="secondary" component="a" href="/get-started/contribute"> Contribute to PatternFly</Button>

Note to change this if #3926 closes. Could be handled in a followup issue that updates links across the website, assuming there's a few areas that would need this change

srambach

Few comments/questions, but nothing major.

srambach · 2024-05-21T23:32:18Z

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

+      </CardFooter>
+    </Card>
+     <Card isCompact>
+      <CardTitle className="pf-v5-u-font-size-l"> Follow us on Twitter </CardTitle>


Should this be X now? 🙄

Ahhh yes, good catch! It's still Twitter in my head 😅

Actually, since there are a few places across the site that mention Twitter, I'll also open a separate issue to update everywhere else. Going ahead and changing it here, though!

srambach · 2024-05-21T23:38:30Z

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

+
+## Release cadence
+
+We plan to release a new major version of PatternFly every year. These major releases will be the only releases with planned "breaking" changes that alter core code functionality. Along with each major release, we will provide detailed upgrade guides and codemods to support the work needed to upgrade your products to the latest version of PatternFly.


"breaking" changes that alter core code functionality - since we use "core" as the css repo, should this be something like "breaking changes" that alter the way your code interacts with the PatternFly code or something like that? Or say PatternFly's API but it's not an API like some may define it.

great point! I like that suggestion

srambach · 2024-05-21T23:57:20Z

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

+
+Occasionally, after a component is promoted out of beta, subsequent enhancement requests require the introduction of new CSS class names and React properties. Whenever these enhancements are substantial enough to lead to further component updates (pending testing and feedback), then a beta label is applied to the new class names and properties, as well as relevant examples in the component’s documentation.
+
+[Learn more about beta components and view a list of current promotion candidates here.](https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion)


oh boy, the content at this link could use some updating! 😄

andrew-ronaldson · 2024-05-22T13:34:10Z

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

+<Grid sm={12} md={4} hasGutter>
+<Button size="lg" variant="secondary" component="a" href="/get-started/design"> Start designing </Button>
+<Button size="lg" variant="secondary" component="a" href="/get-started/develop"> Start developing </Button>
+<Button size="lg" variant="secondary" component="a" href="/get-started/contribute"> Contribute to PatternFly</Button>


this link seems to be broken. I think it's this one get-started/contribute/contributing-to-patternfly

hm so this pr, which will probably be merged at the same time as this one, changes the url to be /get-started/contribute. Do you think I should keep the link as get-started/contribute/contributing-to-patternfly in this pr and just do a follow up once these are all merged?

Merge them all! lol

srambach

🌟 Changes look good!

- @patternfly/ast-helpers@1.4.0-alpha.21 - @patternfly/documentation-framework@6.0.0-alpha.32

andrew-ronaldson

Sweet moves!

This reverts commit 74987c5.

This reverts commit da19484.

This reverts commit eef3d14.

edonehoo added 5 commits March 21, 2024 16:18

Editing content.

46b324f

Adds cards and adjusts layout of content.

50007bb

Content edits.

f4ab47b

Adjusts content.

d54a2a2

docs(get-started): Updates about patternfly page.

79ada1f

edonehoo changed the base branch from main to v6 March 22, 2024 13:36

edonehoo self-assigned this Mar 22, 2024

edonehoo added the Content label Mar 22, 2024

edonehoo requested review from srambach and andrew-ronaldson March 22, 2024 15:18

Merge branch 'v6' into iss3897

11b767b

andrew-ronaldson requested changes Mar 26, 2024

View reviewed changes

edonehoo added 2 commits April 8, 2024 16:24

Updates per feedback.

a80b52d

Update package version.

fbc5222

edonehoo commented Apr 10, 2024

View reviewed changes

packages/documentation-site/package.json Outdated Show resolved Hide resolved

Update packages/documentation-site/package.json

6c70af8

edonehoo commented Apr 10, 2024

View reviewed changes

packages/documentation-site/package.json Outdated Show resolved Hide resolved

edonehoo and others added 4 commits April 10, 2024 16:33

Update packages/documentation-site/package.json

2bf3401

Merge branch 'v6' into iss3897

bead728

Updates version again.

004cea6

Fix links.

5f11167

edonehoo added 2 commits April 23, 2024 14:19

Content updates.

a7e563b

Updates content per feedback.

4016ba9

edonehoo and others added 2 commits May 7, 2024 13:53

Adds mailing list link.

1435d7a

Merge branch 'v6' into iss3897

208199b

edonehoo commented May 8, 2024

View reviewed changes

Merge branch 'v6' into iss3897

2ad9f39

srambach reviewed May 22, 2024

View reviewed changes

Updates content per feedback.

74987c5

edonehoo requested review from andrew-ronaldson and srambach May 22, 2024 12:23

andrew-ronaldson reviewed May 22, 2024

View reviewed changes

srambach approved these changes May 23, 2024

View reviewed changes

wise-king-sullyman and others added 3 commits May 23, 2024 14:14

Merging.

eef3d14

chore(release): releasing packages [ci skip]

e22f39c

- @patternfly/ast-helpers@1.4.0-alpha.21 - @patternfly/documentation-framework@6.0.0-alpha.32

Update package version.

f9fa785

andrew-ronaldson approved these changes May 28, 2024

View reviewed changes

wise-king-sullyman and others added 5 commits May 28, 2024 15:49

Revert "Updates content per feedback."

da19484

This reverts commit 74987c5.

Revert "Revert "Updates content per feedback.""

9b5cbac

This reverts commit da19484.

Revert "Merging."

4ba1444

This reverts commit eef3d14.

Merge branch 'v6' into iss3897

34c050f

Update links and docs site version.

223fe24

jessiehuff approved these changes May 29, 2024

View reviewed changes

jessiehuff merged commit 2db13a7 into patternfly:v6 May 29, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(get-started): Updates "about PatternFly" page. #3930

docs(get-started): Updates "about PatternFly" page. #3930

edonehoo commented Mar 22, 2024

edonehoo commented Mar 22, 2024 •

edited

patternfly-build commented Mar 22, 2024 •

edited

andrew-ronaldson left a comment

srambach commented Apr 18, 2024

edonehoo commented Apr 29, 2024

edonehoo May 8, 2024 •

edited

srambach left a comment

srambach May 21, 2024

edonehoo May 22, 2024

srambach May 21, 2024

edonehoo May 22, 2024

srambach May 21, 2024

andrew-ronaldson May 22, 2024

edonehoo May 22, 2024 •

edited

andrew-ronaldson May 22, 2024

srambach left a comment

andrew-ronaldson left a comment

	<Button size="lg" variant="secondary" component="a" href="/get-started/contribute/contributing-to-patternfly"> Contribute to PatternFly</Button>
	<Button size="lg" variant="secondary" component="a" href="/get-started/contribute"> Contribute to PatternFly</Button>


		## Release cadence

		We plan to release a new major version of PatternFly every year. These major releases will be the only releases with planned "breaking" changes that alter core code functionality. Along with each major release, we will provide detailed upgrade guides and codemods to support the work needed to upgrade your products to the latest version of PatternFly.


		Occasionally, after a component is promoted out of beta, subsequent enhancement requests require the introduction of new CSS class names and React properties. Whenever these enhancements are substantial enough to lead to further component updates (pending testing and feedback), then a beta label is applied to the new class names and properties, as well as relevant examples in the component’s documentation.

		[Learn more about beta components and view a list of current promotion candidates here.](https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion)

docs(get-started): Updates "about PatternFly" page. #3930

docs(get-started): Updates "about PatternFly" page. #3930

Conversation

edonehoo commented Mar 22, 2024

edonehoo commented Mar 22, 2024 • edited

patternfly-build commented Mar 22, 2024 • edited

andrew-ronaldson left a comment

Choose a reason for hiding this comment

srambach commented Apr 18, 2024

edonehoo commented Apr 29, 2024

edonehoo May 8, 2024 • edited

Choose a reason for hiding this comment

srambach left a comment

Choose a reason for hiding this comment

srambach May 21, 2024

Choose a reason for hiding this comment

edonehoo May 22, 2024

Choose a reason for hiding this comment

srambach May 21, 2024

Choose a reason for hiding this comment

edonehoo May 22, 2024

Choose a reason for hiding this comment

srambach May 21, 2024

Choose a reason for hiding this comment

andrew-ronaldson May 22, 2024

Choose a reason for hiding this comment

edonehoo May 22, 2024 • edited

Choose a reason for hiding this comment

andrew-ronaldson May 22, 2024

Choose a reason for hiding this comment

srambach left a comment

Choose a reason for hiding this comment

andrew-ronaldson left a comment

Choose a reason for hiding this comment

edonehoo commented Mar 22, 2024 •

edited

patternfly-build commented Mar 22, 2024 •

edited

edonehoo May 8, 2024 •

edited

edonehoo May 22, 2024 •

edited