search

patternfly / react-topology

MIT License
8 stars 17 forks source link

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

Closed edonehoo closed 21 hours ago

edonehoo commented 1 month ago

Closes https://github.com/patternfly/react-topology/issues/180 and also https://github.com/patternfly/patternfly-org/issues/3949

patternfly-build commented 1 month ago

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

edonehoo commented 1 month ago

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?

edonehoo commented 4 weeks ago

@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!

jeff-phillips-18 commented 3 weeks ago

@edonehoo Could you please squash your commits?

edonehoo commented 2 weeks ago

@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 commented 2 weeks ago

@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: https://github.com/edonehoo/react-topology/pull/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!

edonehoo commented 1 week ago

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