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

test build for restructure #4635

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Nov 20, 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)

Copy link
Contributor

👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/components/components-overview.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@akeller akeller added the hold This issue is parked, do not merge. label Nov 20, 2024
@christinaausley christinaausley removed their assignment Nov 20, 2024
@akeller akeller added the deploy Stand up a temporary docs site with this PR label Nov 20, 2024
Copy link
Contributor

🚧 The preview environment for the commit f0586d4 is being built. This usually takes 15-20 minutes.

Copy link
Member

@korthout korthout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I really like that we don't ship our architecture in the docs as the top-level anymore, and instead introduce the usage patterns in the guides: manage, design, automate, and improve. A user wants to follow a guide to solve a problem or reach a goal. So, IMO, this fits much better

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