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

Improvements to Dedicated docs #4221

Open
Kemi-Elizabeth opened this issue Oct 9, 2024 · 4 comments · May be fixed by #4249
Open

Improvements to Dedicated docs #4221

Kemi-Elizabeth opened this issue Oct 9, 2024 · 4 comments · May be fixed by #4249
Assignees

Comments

@Kemi-Elizabeth
Copy link
Collaborator

Where on docs.platform.sh should be changed?

DG2/DG3 docs will be improved according to plans outlined in this spreadsheet: https://docs.google.com/spreadsheets/d/1XUaNbDgEu-6VUfbu9Gk2nQc7k7uuUBBa7qbSTL86Fpo/edit?gid=0#gid=0

What exactly should be updated?

https://docs.platform.sh/dedicated-gen-2/overview.html
https://docs.platform.sh/dedicated-gen-3.html

New pages will be added to these sections with another higher level that provides an overview for the Dedicated offering overall.

Additional context

No response

@Kemi-Elizabeth Kemi-Elizabeth self-assigned this Oct 10, 2024
@Kemi-Elizabeth Kemi-Elizabeth linked a pull request Nov 7, 2024 that will close this issue
@Kemi-Elizabeth Kemi-Elizabeth linked a pull request Nov 7, 2024 that will close this issue
@gilzow
Copy link
Collaborator

gilzow commented Nov 7, 2024

Adding one comment outside my review since it covers all the changed files: we should replace the absolute URL links with relative links so the links go to the correct locations in preview environments.

@gilzow
Copy link
Collaborator

gilzow commented Nov 7, 2024

Another general comment: We seem to flip between "Development environment(s)" and "Development Environment(s)" and I can't tell if there's a specific logic to when one is used vs the other.

@gilzow
Copy link
Collaborator

gilzow commented Nov 7, 2024

Another one: we seem to flip between the term "autonomous" (dedicated environments overview) and "Self-service via yaml config files" (DG3 / DG2 overviews). We should be consistent across them.

@Kemi-Elizabeth
Copy link
Collaborator Author

Thanks Paul! All the inconsistencies regarding Autonomous and Dedicated Environments have been solved. In the docs, I've set it so we only capitalize the E in Dedicated Environments if it's in direct relation to Dedicated. If we're referencing development, production, staging or anything else then the E is lower case. I've also changed Autonomous to self-service.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants