patternfly-org icon indicating copy to clipboard operation
patternfly-org copied to clipboard

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

Open edonehoo opened this issue 1 year ago • 4 comments

Closes #3897

edonehoo avatar Mar 22 '24 13:03 edonehoo

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

edonehoo avatar Mar 22 '24 13:03 edonehoo

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

patternfly-build avatar Mar 22 '24 13:03 patternfly-build

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?

srambach avatar Apr 18 '24 14:04 srambach

@srambach ty for the feedback!!

  1. 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

  2. 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)
  1. 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 https://github.com/patternfly/patternfly-design/issues/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 avatar Apr 29 '24 17:04 edonehoo