-
Notifications
You must be signed in to change notification settings - Fork 768
[docs] Migrate docs from AsciiDoc to Markdown #8496
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
Conversation
This PR cannot be merged until the CI jobs are adjusted (https://buildkite.com/elastic/cloud-on-k8s-operator/builds/10389#019547bc-f8e5-46dd-93a0-1ae3a0f48d99). Based on @pebrc comments, the steps to take are:
|
Part of #8498 https://docs-v3-preview.elastic.dev/elastic/cloud-on-k8s/pull/8501/reference/ Adjust the templating for the API reference. Markdown was modelled after #8496 Differences to the manually migrated files: API reference tool creates a single file not a file per group, we could however adjust that if needed.
@eedugon can we get this into a mergeable state? As we are preparing for the 3.0 release and we need to make docs changes it would be good to have the docs as close as possible to the final file layout to avoid double effort on our end maintaining changes in two repos. |
on it @pebrc ! |
@pebrc : FYI, while fixing the conflicts:
The previous files should be updated only in branches different than main or |
@pebrc , the build is failing because of the links auto-generated in The new links look like:
And in the static content we had provided they looked like:
I'm sorry I didn't get this in your previous PR. Would you please fix the auto-generated file in main? As an extra issue, the markdown comments in the new Docs V3 system should be made with
It should be: % Generated documentation. Please do not edit. |
I can open a PR against the new docs repo for that.
We can ignore this change as it was backported to the 2.16 branch already. |
You are running into another problem with the build. Lines 499 to 507 in 95acd68
This is some code that we added to verify that the documentation was always up to date compared to the code. Unfortunately with the docs moving out of this repo this check won't work anymore and you will have to either remove it or move the documentation of the update predicates back into this repo as reference documenation. |
working on this, @pebrc, thanks for flagging it. |
Moving the ECK upgrade predicates to reference documentation per elastic/cloud-on-k8s#8496 (comment) - [Advanced control during rolling upgrades](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/697/deploy-manage/deploy/cloud-on-k8s/nodes-orchestration#k8s-advanced-upgrade-control) @shainaraskas : Let me know your thoughts, as this isn't exactly what we have talked about :) I'd like to know if you like it this way or if you prefer to keep the example and all narrative in this doc. I think it's simpler this way, having only an introduction to the topic and a link to the reference documentation for the list of predicates and the use case example. --------- Co-authored-by: shainaraskas <[email protected]>
@pebrc : This PR is mergeable now. Feel free to review it. We have added to In the main nodes orchestration doc we have updated the content with just an introduction and link to reference in the Advanced control during rolling upgrades section. Let us know your thoughts. We can also change the title of the new reference doc at a later stage. |
Co-authored-by: Peter Brachwitz <[email protected]>
Co-authored-by: Peter Brachwitz <[email protected]>
Migrates docs from AsciiDoc to Markdown
Preview available at https://docs-v3-preview.elastic.dev/elastic/cloud-on-k8s/pull/8496/reference
This PR should substitute #8494 created by @colleenmcginnis (I didn't have permissions to merge the latest changes in main, and I might need to add a few extra changes to the content).
This PR: