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

Lift more info to Supported environments page #3310

Merged
merged 29 commits into from
Mar 15, 2024
Merged

Lift more info to Supported environments page #3310

merged 29 commits into from
Mar 15, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented Feb 9, 2024 •
edited
Loading

Description

Closes #3306.

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:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Feb 9, 2024
@akeller akeller requested a review from MaxTru February 9, 2024 20:47
@akeller akeller self-assigned this Feb 9, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 9, 2024 •
edited
Loading

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@MaxTru
Copy link
Contributor

MaxTru commented Feb 12, 2024

I added some comments. Overall: @akeller could you please try to rework this PR in a way that the user can easily read and understand what the minium requimrenets are to install, run, operate C8 SM? So focus on the "must-have" vs "recommendation"

@akeller
Copy link
Member Author

akeller commented Feb 16, 2024

After a working session with Max, I have more improvements to this page. I will cleanup the PR today, allow reviewers time on Monday and Tuesday, and then backport and merge Tuesday during US working hours.

Related Slack thread - https://camunda.slack.com/archives/C026U8GBNSW/p1708101642758599

@akeller akeller requested a review from MoAtCamunda February 16, 2024 21:21
@akeller
Copy link
Member Author

akeller commented Feb 16, 2024

@theburi FYI, during the working session, we removed some of the areas you made comments on in favor of deep links and did not expand the scope of the PR to include new platforms or deployment options. Please follow up on those with epics, as I mentioned.

@akeller akeller dismissed MoAtCamunda’s stale review February 22, 2024 20:26

Got a "Looks good from my perspective" from Mo on Slack

@akeller akeller added the hold This issue is parked, do not merge. label Feb 23, 2024
@akeller
Copy link
Member Author

akeller commented Feb 23, 2024

Adding the hold label since more comments came in on the Google doc and may impact changes here.

I'll plan to cleanup the merge conflicts later today or Monday.

megglos
megglos previously approved these changes Feb 28, 2024
View reviewed changes
Copy link
Contributor

@megglos megglos left a comment

Choose a reason for hiding this comment

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

LGTM! One suggestion for stating no types of network based storage is supported.

@akeller akeller mentioned this pull request Mar 4, 2024
Closed
@akeller akeller dismissed stale reviews from megglos and christinaausley via 4425c6e March 4, 2024 19:45
akeller and others added 3 commits March 4, 2024 13:45
@akeller @megglos
Add other network storage types (review suggestion)
4425c6e 
Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>
@akeller
merge conflicts
4170fd8
@akeller
merge conflicts
124c1be
MaxTru
MaxTru requested changes Mar 6, 2024
View reviewed changes
@akeller
Update docs/reference/supported-environments.md
40b998e 
As agreed in a huddle with Max
MaxTru
MaxTru previously approved these changes Mar 15, 2024
View reviewed changes
@akeller akeller requested a review from christinaausley March 15, 2024 14:57
@akeller akeller removed the hold This issue is parked, do not merge. label Mar 15, 2024
@akeller
Copy link
Member Author

akeller commented Mar 15, 2024

@christinaausley can I get a 👍 from you so we can marge this PR? 🎉

@akeller akeller enabled auto-merge (squash) March 15, 2024 15:42
@akeller akeller merged commit d966468 into main Mar 15, 2024
6 checks passed
@akeller akeller deleted the lift-kube-reqs-to-supported-env branch March 15, 2024 17:26
theburi pushed a commit that referenced this pull request Apr 3, 2024
@akeller @MaxTru
@christinaausley @megglos @theburi
Lift more info to Supported environments page (#3310)
7cfbf68 
* initial info gathering

* fix links

* add minimum section, small adjustments

* add review recommendations

* small tweaks

* add nfs warning

* refactor page

* Update docs/reference/supported-environments.md

Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com>

* add spacing to break up text wall

* backport to 8.4

* add back 16.x

* backport 8.3

* Update docs/reference/supported-environments.md

Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com>

* backport change to first sentence

* add helm chart compatibility admonition

* reword first sentence in component version matrix section

* rework deployment options section

* add link to certified kubernetes

* style(formatting): technical review

* Add other network storage types (review suggestion)

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update docs/reference/supported-environments.md

As agreed in a huddle with Max

* ensure changes are backported appropriately

---------

Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com>
Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>
theburi pushed a commit that referenced this pull request Jun 5, 2024
@akeller @MaxTru
@christinaausley @megglos @theburi
Lift more info to Supported environments page (#3310)
683b93a 
* initial info gathering

* fix links

* add minimum section, small adjustments

* add review recommendations

* small tweaks

* add nfs warning

* refactor page

* Update docs/reference/supported-environments.md

Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com>

* add spacing to break up text wall

* backport to 8.4

* add back 16.x

* backport 8.3

* Update docs/reference/supported-environments.md

Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com>

* backport change to first sentence

* add helm chart compatibility admonition

* reword first sentence in component version matrix section

* rework deployment options section

* add link to certified kubernetes

* style(formatting): technical review

* Add other network storage types (review suggestion)

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update docs/reference/supported-environments.md

As agreed in a huddle with Max

* ensure changes are backported appropriately

---------

Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com>
Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@theburi theburi theburi left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@christinaausley christinaausley christinaausley approved these changes

@megglos megglos megglos left review comments

@MaxTru MaxTru MaxTru left review comments

@hisImminence hisImminence hisImminence left review comments

@MoAtCamunda MoAtCamunda Awaiting requested review from MoAtCamunda

Assignees

@akeller akeller

Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Documentation Team
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve Support Environments page to be more inclusive of ALL platforms & deployments
7 participants
@akeller @MaxTru @MoAtCamunda @megglos @theburi @hisImminence @christinaausley