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.

Sign up for GitHub

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

Jump to bottom

Experimental structure PR #4213

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Experimental structure PR #4213

wants to merge 7 commits into from
+75 −0

Conversation

akeller
Copy link
Member

@akeller akeller commented Aug 29, 2024 •
edited
Loading

Description

This PR creates an "Experimental" section in the Components area of the docs with a landing page and 4 dedicated experimental feature pages.

image

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Aug 29, 2024
@akeller akeller self-assigned this Aug 29, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 29, 2024 •
edited
Loading

👋 🤖 🤔 Hello! 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/early-access/experimental/feature1.md
  • docs/components/early-access/experimental/feature2.md
  • docs/components/early-access/experimental/feature3.md
  • docs/components/early-access/experimental/feature4.md
  • docs/components/early-access/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.

@github-actions github-actions bot temporarily deployed to camunda-docs August 29, 2024 16:58 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs August 29, 2024 17:50 Destroyed
lmbateman
lmbateman reviewed Aug 30, 2024
View reviewed changes
Copy link
Contributor

@lmbateman lmbateman left a comment

Choose a reason for hiding this comment

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

This seems fine to me. I can see it under Next but not 8.5, which I think is the goal.

@PhilippaC22
Copy link

@christinaausley structure looks good - Have added some design suggestions around this here as well as naming ideas too.
See Figjam

@akeller
Copy link
Member Author

akeller commented Sep 5, 2024

We won't use "experimental" in the official, shipped version. See my update on Slack - https://camunda.slack.com/archives/C0484UFR2VA/p1725571619654449

@christinaausley
Copy link
Contributor

christinaausley commented Sep 17, 2024 •
edited
Loading

@camundom @melanie-butcher sounds like you are perhaps putting together some design ideas? Do we have any strong opinions around some of the potential naming terms based on the Slack thread linked above? Also happy to hop on a call and discuss.

@camundom
Copy link
Contributor

@camundom @melanie-butcher sounds like you are perhaps putting together some design ideas? Do we have any strong opinions around some of the potential naming terms based on the Slack thread linked above? Also happy to hop on a call and discuss.

Hi @christinaausley, here's a link to the draft design for the docs, includes a revised structure for early access/experimental features, along with few open questions. Please let me know what you think.

@christinaausley
Copy link
Contributor

christinaausley commented Oct 3, 2024 •
edited
Loading

Thanks for meeting with me today @camundom -- please let me know if I can assist with incorporating the changes here once the finalities of the design are discussed with @bastiankoerber.

YanaSegal
YanaSegal previously approved these changes Oct 7, 2024
View reviewed changes
@akeller akeller removed the deploy Stand up a temporary docs site with this PR label Oct 7, 2024
@akeller
Copy link
Member Author

akeller commented Oct 7, 2024

Removing deploy since it's currently broken. 😢

@christinaausley
Copy link
Contributor

Hi @camundom -- based on your draft design, can I go ahead and update this PR so we have a place to put content before CCon?

@christinaausley
Copy link
Contributor

@akeller It's looking like I can start pulling some experimental CCon documentation into GitHub. How do we feel about merging those into this branch once the structure is ready to go?

@akeller akeller added the deploy Stand up a temporary docs site with this PR label Oct 9, 2024
@akeller
Copy link
Member Author

akeller commented Oct 9, 2024

@akeller It's looking like I can start pulling some experimental CCon documentation into GitHub. How do we feel about merging those into this branch once the structure is ready to go?

Doesn't matter to me! I'll leave it with the team to decide on names, etc. Also if it's easier to close this PR out and start fresh, that works too.

@github-actions github-actions bot temporarily deployed to camunda-docs October 9, 2024 18:33 Destroyed
@camundom
Copy link
Contributor

camundom commented Oct 10, 2024 •
edited
Loading

Hi @camundom -- based on your draft design, can I go ahead and update this PR so we have a place to put content before CCon?

Hi @christinaausley , yes that can be done. I've also received final approval to the design/structure that would be used for CCon. Please let me know if there's any way that I can help you with this. Thanks

@christinaausley
Copy link
Contributor

Thanks @camundom -- prepping this today and tomorrow.

@github-actions github-actions bot temporarily deployed to camunda-docs October 10, 2024 17:21 Destroyed
@christinaausley christinaausley mentioned this pull request Oct 10, 2024
Open
9 tasks
@github-actions GitHub Actions
Copy link
Contributor

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

christinaausley
christinaausley reviewed Oct 11, 2024
View reviewed changes
sidebars.js
@@ -689,6 +689,21 @@ module.exports = {
},
],
},
{
Copy link
Contributor

Choose a reason for hiding this comment

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

Will update sidebar once we get RPA and SAP in here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaausley christinaausley christinaausley left review comments

@lmbateman lmbateman lmbateman left review comments

@YanaSegal YanaSegal YanaSegal left review comments

@bastiankoerber bastiankoerber Awaiting requested review from bastiankoerber

@PhilippaC22 PhilippaC22 Awaiting requested review from PhilippaC22

At least 1 approving review is required to merge this pull request.

Assignees

@akeller akeller

@christinaausley christinaausley

Labels
deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge.
Projects
Developer Experience
Status: 🏗 In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@akeller @PhilippaC22 @christinaausley @camundom @YanaSegal @lmbateman