Docs(Topology): Edits content as part of audit.

[edonehoo]

Closes #180 and also patternfly/patternfly-org#3949

[patternfly-build]

Preview: https://react-topology-pr-topology-197.surge.sh

[edonehoo]

cc: @jessiehuff (just fyi!)

Hi 👋 @jenny-s51 @jeff-phillips-18! I've finished my first pass at updating Topology docs as part of the Org content audit. I also included README updates here. Would love to hear thoughts/feedback when you have time to review 🤠

Some notes and questions below --

1. At least one of my changes has messed up the org build, though I'm not sure which.

   • "untitled example" was added at a heading at the top of each page and
   • the example/demo previews are cropped smaller.

2. I added a blurb at the top of each page to shortly define the page's subject. This resembles what we do across the site, but lmk if you have thoughts! Other pages put the blurb in a separate header drawer, but idk if that functionality is easy or necessary to add here (but fyi as an ex: https://www.patternfly.org/components/about-modal).

3. There are probably some inconsistencies in code formatting that I may need help understanding. For example, in other React docs, we stylize React components as <ReactComponent> and properties as reactProp, to try and distinguish the two. I made some changes in this first pass, but felt like I was mostly guessing. Plus, I'm not sure what a "utility" equates to, which is a term used in some of these docs.

4. Some pages don't have any props table at the bottom. Is that intentional, or do you see any places where some props references should be added?

[jenny-s51]

These changes are awesome @edonehoo - lots of valuable improvements to the Topology docs. I've walked through all your changes and left comments for additional tweaks/updates, but overall it's looking great.

I've also submitted a pull request on your branch with markdown/formatting updates to the demos, which will resolve the "Untitled example" issue you encountered and add some alignment fixes. You can find those changes here.

Thanks again for your hard work on this and your dedication to improving our documentation!

[edonehoo]

@jenny-s51 thank you So much! 🤩 I pulled in your pr and the only thing I'm noticing is that the example window still looks cut off on the "about Topology" and "Pan and zoom" pages. Are you also seeing that? Otherwise, I think this is looking great!

[jenny-s51]

Thank you @edonehoo for making those updates - your changes are looking great!

Opened a PR on your branch to fix the demo height issue: edonehoo#2

[jenny-s51]

Thanks for making those updates @edonehoo ! Noticed just a couple small things as I did another sweep through your docs changes.

Otherwise LGTM; will pass it off to @jeff-phillips-18 for a final review. Thanks again for your awesome work on this, Erin!

[jeff-phillips-18]

@edonehoo Could you please squash your commits?

[edonehoo]

@jeff-phillips-18 hm tried to do that via vs code terminal and had issues. It's not something I've done before, so I'm not sure I went about it the right way. Will "squash and merge" in the gui achieve the same thing? or if either of you have time to walk through it with me, I can add something on our calendars!

[jenny-s51]

@edonehoo you're absolutely right - that was a tricky merge! 🙌 I've managed to handle the merge conflicts and squash all your commits; opened a pull request in your branch here: edonehoo#3.

I'm happy to meet and walk you through the process -- here's how I typically handle it:

1. Rebasing over main:
   I start by rebasing my branch over main to incorporate the latest changes:

git checkout my-branch
git rebase upstream/main

2. Interactive rebase (git rebase -i HEAD~[number of commits in PR]):

Then, I perform an interactive rebase to squash commits:

git rebase -i HEAD~[number of commits]
In the interactive rebase window, I squash all commits except for the first one, and make sure to update the first commit message to use semver i.e. fix(thing): what you changed

Let me know if you have any questions - always happy to clarify!

[jenny-s51]

Hi @jeff-phillips-18 when you have a moment to review, would be much appreciated! Met with @edonehoo this afternoon and we rebased and squashed the commits

[jeff-phillips-18]

Why do I need to do this?

[edonehoo]

@jeff-phillips-18 thanks for the feedback! I made some changes -- let me know if I missed or misinterpreted anything

[andrew-ronaldson]

Looks great, thanks!