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

migrate alpha feaures landing page #4465

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

christinaausley
Copy link
Contributor

Description

Relates to #4213 (comment). Trials moving the alpha features page to components.

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/).

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Oct 15, 2024
@christinaausley christinaausley self-assigned this Oct 15, 2024
Copy link
Contributor

👋 🤖 🤔 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/apis-tools/camunda-api-rest/camunda-api-rest-overview.md
  • docs/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha.api.mdx
  • docs/apis-tools/testing/getting-started.md
  • docs/components/connectors/out-of-the-box-connectors/kafka.md
  • docs/components/console/manage-organization/enable-alpha-features.md
  • docs/components/early-access/alpha/alpha-features.md
  • docs/components/early-access/overview.md
  • docs/components/modeler/web-modeler/advanced-modeling/camunda-docs-ai.md
  • docs/reference/overview.md
  • docs/reference/release-policy.md
  • docs/self-managed/setup/deploy/local/c8run.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 October 15, 2024 17:24 Destroyed
Copy link
Contributor

The preview environment relating to the commit 67a800e has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4465/index.html

@christinaausley christinaausley requested review from akeller and a team October 17, 2024 13:09
@christinaausley christinaausley marked this pull request as ready for review October 17, 2024 13:12
@christinaausley
Copy link
Contributor Author

Just need to add a redirect.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

This looks like it's in a good state to me, with just one comment where another link might be helpful.

  • Is it worth taking the "General Availability" section out of the Alpha features page, and instead adding it to the Release policy page? It seems like it could better serve as a standing definition for reference, as opposed to being mentioned only within /components with the rest of this content.

  • Possibly for a discussion outside of this PR: I didn't immediately assume the overview pages were going to be part of the top-level category in the sidebar. The Components section defaults to using a separate overview or introductory page, generally, but I don't think we have consistency for this assumption across the docs, so it's not something I think needs to change here - but we may want to visit this behavior more broadly (I've put it on our sync notes!).

@@ -20,7 +20,7 @@ These features may be unstable, and subject to significant changes or removal.

## Alpha features

[Alpha features](/reference/alpha-features.md) are more developed and closer to becoming part of the product but may not yet be fully optimized or supported. Selected Camunda features and components are released as alpha versions to provide early access. By testing these features, you have the opportunity to participate in their development by sharing feedback before they reach General Availability (GA).
[Alpha features](/components/early-access/alpha/alpha-features.md) are more developed and closer to becoming part of the product but may not yet be fully optimized or supported. Selected Camunda features and components are released as alpha versions to provide early access. By testing these features, you have the opportunity to participate in their development by sharing feedback before they reach General Availability (GA).
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to link "General Availability (GA)" here to that section of the alpha features doc, like it is on the other page?

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
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

2 participants