Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DRAFT RESTRUCTURE #4627

Closed
wants to merge 3 commits into from
Closed

DRAFT RESTRUCTURE #4627

wants to merge 3 commits into from

Conversation

akeller
Copy link
Member

@akeller akeller commented Nov 19, 2024

This PR is NOT in a state to merge and should only be for discussion purposes.

  • Move all guides from Components to Guides
    • Get started (as-is)
    • Manage > Console guides (as-is)
    • Design > Modeler (requires extensive review, difficult to split or move as-is)
    • Automate > Connectors, Zeebe, Tasklist, Operate
      • Connectors (requires review, content split between Guides & Concepts)
      • Zeebe (all concepts, no guides)
      • Tasklist (move user guide, drop overview/intro page)
      • Operate (move user guide, drop overview/intro page)
    • Improve > Optimize (move user guide, drop overview/intro page)
    • Migrate from C7
  • Rename Components to Concepts
  • Rework any renaming content in Concepts to a cohesive structure
image

But I love it! Why can't we just merge this?!

  • No actual content moves, just sidebars moves
  • No redirects
  • No buy-in from stakeholders (yet, hence the draft PR for discussions)
  • Renaming a top nav item will impact all supported versions
  • Possible duplicate/redundant guide content
  • Lacks holistic perspective/intention for Guide and Concepts (could be fixed with an extensive review)

@akeller akeller added hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Nov 19, 2024
@akeller akeller self-assigned this Nov 19, 2024
@korthout
Copy link
Member

Awesome! I think it's a great idea to extract the guides!

@akeller For easy reviewing, could you add some screenshots showing the new structure?

@akeller
Copy link
Member Author

akeller commented Nov 20, 2024

Awesome! I think it's a great idea to extract the guides!

@akeller For easy reviewing, could you add some screenshots showing the new structure?

Oh shoot, I was hoping this would deploy and you could run it! I can add screenshots later today

@akeller akeller added hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR and removed hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Nov 20, 2024
@akeller akeller marked this pull request as ready for review November 20, 2024 18:51
@akeller akeller closed this Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants