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

Guides reorganization for initial IA + vendorization #3368

Merged
merged 30 commits into from
Sep 8, 2023
Merged

Guides reorganization for initial IA + vendorization #3368

merged 30 commits into from
Sep 8, 2023

Conversation

chadwcarlson
Copy link
Collaborator

@chadwcarlson chadwcarlson commented Aug 18, 2023 •
edited
Loading

Why

Closes #3348
Closes #2972

What's changed

  • "Guides" are moved out of "Reference", for better vendor inheritance
  • Includes "overview", which acted as a makeshift homepage. Now this is it's own "What is Platform.sh?" guide
  • Simple proper homepage with links to important sections and community links
  • fixes on sidebar logic to move these guides/books around properly, preserving is-active logic
  • Removes Tutorials > Third-Party resources; primary issue becomes Import docs third-party resources  awesome-platformsh#5
  • Postgres is added to accept.txt for Vale, as it was introduced in https://github.com/platformsh/platformsh-docs/pull/3391/files

Not addressed

"Frameworks" will be largely rewritten within "Get started", but there will be many links to pages in frameworks that will need dealing with in order to remove that section. So, that is not addressed here.

Todo

  • cleanup & resolve homepage items
  • match reorg/homepage usage for white-label sites
  • fix existing is-active logic for homepage
  • fix homepage/guide creation of "introduction" page
  • fix homepage title
  • fix any broken links
  • define redirects to moved sections
  • Address Vale errors (should be fixed by [Bug-fix] Vale fixes #3378)

@chadwcarlson chadwcarlson added this to the White Label MVP milestone Aug 18, 2023
@chadwcarlson chadwcarlson mentioned this pull request Aug 21, 2023
Open
@chadwcarlson chadwcarlson added website For issues about the docs website (features and such), not the docs themselves and removed WIP labels Aug 21, 2023
@platformsh platformsh deleted a comment from github-actions bot Aug 22, 2023
@platformsh platformsh deleted a comment from github-actions bot Aug 22, 2023
@github-actions
Copy link

github-actions bot commented Aug 22, 2023 •
edited
Loading

Your Platform.sh environment has successfully deployed. 🚀

See the changed pages:

@chadwcarlson chadwcarlson removed the website For issues about the docs website (features and such), not the docs themselves label Aug 22, 2023
@chadwcarlson chadwcarlson added the upcoming version Docs for upcoming releases / versions label Aug 22, 2023
AnouckColson
AnouckColson suggested changes Aug 23, 2023
View reviewed changes
sites/friday/src/_index.md Outdated Show resolved Hide resolved
sites/friday/src/_index.md Outdated Show resolved Hide resolved
sites/friday/src/_index.md Outdated Show resolved Hide resolved
sites/friday/src/_index.md Outdated Show resolved Hide resolved
sites/friday/src/_index.md Outdated Show resolved Hide resolved
sites/platform/src/learn/overview/philosophy.md Outdated Show resolved Hide resolved
themes/psh-docs/layouts/shortcodes/home/table.html Outdated Show resolved Hide resolved
themes/psh-docs/layouts/shortcodes/home/table.html Outdated Show resolved Hide resolved
themes/psh-docs/layouts/shortcodes/home/table.html Outdated Show resolved Hide resolved
themes/psh-docs/layouts/shortcodes/home/table.html Outdated Show resolved Hide resolved
@chadwcarlson chadwcarlson removed the upcoming version Docs for upcoming releases / versions label Aug 23, 2023
AnouckColson
AnouckColson suggested changes Aug 24, 2023
View reviewed changes
sites/platform/src/_index.md Outdated Show resolved Hide resolved
sites/platform/src/_index.md Show resolved Hide resolved
@chadwcarlson chadwcarlson added the website For issues about the docs website (features and such), not the docs themselves label Sep 1, 2023
@chadwcarlson
Copy link
Collaborator Author

chadwcarlson commented Sep 7, 2023 •
edited
Loading

  • resolve conflict
  • external link icon on API docs item
  • move "more docs" section into Learn

gilzow
gilzow reviewed Sep 7, 2023
View reviewed changes
.platform/routes.yaml Outdated Show resolved Hide resolved
.platform/routes.yaml Outdated Show resolved Hide resolved
.platform/routes.yaml Outdated Show resolved Hide resolved
.platform/routes.yaml Outdated Show resolved Hide resolved
AnouckColson
AnouckColson previously approved these changes Sep 8, 2023
View reviewed changes
@AnouckColson AnouckColson merged commit aa17f0c into main Sep 8, 2023
9 checks passed
@AnouckColson AnouckColson deleted the vendor/3348-guides branch September 8, 2023 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gilzow gilzow gilzow left review comments

@AnouckColson AnouckColson AnouckColson approved these changes

Assignees
No one assigned
Labels
markdown/prose website For issues about the docs website (features and such), not the docs themselves
Projects
None yet
Milestone
Upsun MVP
3 participants
@chadwcarlson @gilzow @AnouckColson