Skip to content

Add Cloud Hosted Release Notes book #3202

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

Merged
merged 4 commits into from
Apr 10, 2025
Merged

Add Cloud Hosted Release Notes book #3202

merged 4 commits into from
Apr 10, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 7, 2025

This PR is intended as an alternative to #3201, which aims to continue publishing the old Cloud Hosted release notes in the old docs system.

Copy link

github-actions bot commented Apr 7, 2025

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@lcawl lcawl marked this pull request as ready for review April 8, 2025 00:56
@lcawl lcawl requested a review from a team as a code owner April 8, 2025 00:56
@shainaraskas
Copy link
Contributor

I'm not sure if this is on the cloud side or this side, but I think something is wrong here because we're getting all of the pages rendered on one big super-page, no sidebar, and links are not working

e.g. https://docs_bk_3202.docs-preview.app.elstc.co/guide/en/cloud-hosted/current/index.html

image

@lcawl
Copy link
Contributor Author

lcawl commented Apr 8, 2025

I'm not sure if this is on the cloud side or this side, but I think something is wrong here because we're getting all of the pages rendered on one big super-page, no sidebar, and links are not working

Ah, it worked locally so I think it's because I used the "single: 1" which makes sense in the TPEC case but not here. Fixed in e90d5a1

@shainaraskas
Copy link
Contributor

shainaraskas commented Apr 8, 2025

couple small things:

  • variables are not rendering:

    image
  • title should be changed:

    image
  • "Elasticsearch Service" should be replaced with "Elastic Cloud Hosted" everywhere (or maybe "Elastic Cloud" given that we also have console updates in these release notes?)

otherwise, the structure looks good to me. we do have a lot of duplicate headings in the sidebar, but those were present in the old system.

I am a little concerned about the links though - are we cool to rely on redirects to get people to the right place? e.g.:
image
https://docs_bk_3202.docs-preview.app.elstc.co/guide/en/cloud-hosted/current/ec-release-notes-2019-10-23.html

@lcawl
Copy link
Contributor Author

lcawl commented Apr 10, 2025

couple small things:

  • variables are not rendering:

I've got this working by adding references to the version and shared attribute files in https://github.com/elastic/cloud/pull/139928

  • title should be changed:

I changed it to "Elastic Cloud Release Notes" in https://github.com/elastic/cloud/pull/139928 but if there's a better name that's fine by me.

  • "Elasticsearch Service" should be replaced with "Elastic Cloud Hosted" everywhere (or maybe "Elastic Cloud" given that we also have console updates in these release notes?)

I updated the n attribute in https://github.com/elastic/cloud/pull/139928

I am a little concerned about the links though - are we cool to rely on redirects to get people to the right place?

I think since these are old release notes it's okay to have them point to the old docs. They're now working (i.e. pointing to "current") in https://github.com/elastic/cloud/pull/139928

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

as long as this looks right after https://github.com/elastic/cloud/pull/139928, that all works for me !

@lcawl
Copy link
Contributor Author

lcawl commented Apr 10, 2025

run docs-build

@lcawl lcawl merged commit a50dabd into elastic:master Apr 10, 2025
3 checks passed
@lcawl lcawl deleted the cloud-rn branch April 10, 2025 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants