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

Move update guides up sidebar #2336

Merged
merged 2 commits into from
Jul 17, 2023
Merged

Conversation

akeller
Copy link
Member

@akeller akeller commented Jul 13, 2023

Description

Connectors and Elasticsearch appear above the Camunda Platform 8 guides in the sidebar and I'm concerned that could create confusion. This moves those directories below the individual guide pages.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@akeller akeller added the component:docs Documentation improvements, including new or updated content label Jul 13, 2023
@akeller akeller self-assigned this Jul 13, 2023
@akeller
Copy link
Member Author

akeller commented Jul 13, 2023

FYI @bastiankoerber @sbuettner this move the Connectors update guides lower in the sidebar, but I think makes more sense visually.

@sbuettner
Copy link
Contributor

@akeller Thanks!

Just had an idea or maybe hackathon project: Its sometimes tough to imagine how a change might look like without building it locally. The web-modeler team has a dedicated [deploy-preview] label that generates a deployment/build for a branch including a url to access it. Could be nice to have something similar if that is not something you already have and I am just not aware of. ✌️

@akeller
Copy link
Member Author

akeller commented Jul 14, 2023

@sbuettner yes! We have this in our backlog - https://github.com/camunda/developer-experience/issues/66

Inspired by @bastiankoerber after I asked him if he ever ran the docs locally to review PRs 😄

@christinaausley christinaausley merged commit 7f540e2 into main Jul 17, 2023
3 checks passed
@christinaausley christinaausley deleted the adjust-update-guide-list branch July 17, 2023 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants