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

(Doc+) quickstart+KB #8128

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

stefnestor
Copy link
Contributor

👋 howdy, team! This is first pass to streamline the ECK guide for common support misunderstandings. It:

  1. links the sub-quickstart pages to each other to show their required order
  2. updates Elasticsearch + Kibana references to their respective {es} and {kb} doc variables (this is why PR looks big)
  3. links the applicable Kubernetes documentation before each console command
  4. links the in/directly mentioned sister pages (requiring adding some anchors)
  5. moves quickstart pages ("Use persistent storage", "Check out the samples") content in-line
  6. shifts "upgrade deployment" to "update" (since example is modifying not stack version upgrading) and links previously written and common troubleshooting note about downsizing volumes

@stefnestor stefnestor added >enhancement Enhancement of existing functionality >docs Documentation labels Oct 18, 2024
@stefnestor
Copy link
Contributor Author

Build failed on ... which I didn't edit. I imagine something else hidden is wrong with my update if y'all would kindly assist 🙏

INFO:build_docs:asciidoctor: ERROR: operating-eck/operating-eck.asciidoc: line 12: illegal block content outside of partintro block

docs/quickstart.asciidoc Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
@barkbay
Copy link
Contributor

barkbay commented Oct 21, 2024

Build failed on ... which I didn't edit. I imagine something else hidden is wrong with my update if y'all would kindly assist 🙏

Refer to my comment here: #8128 (comment)

docs/quickstart.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: Michael Morello <[email protected]>
@stefnestor
Copy link
Contributor Author

@barkbay, thanks! The last build timed-out but I don't have Buildkite permissions to "rebuild". Would you kindly retry that? 🙏

@thbkrkr
Copy link
Contributor

thbkrkr commented Oct 23, 2024

cloud-on-k8s-operator/build timed out, I retried it. However, docs-build-pr/build failed with:

INFO:build_docs:asciidoctor: ERROR: quickstart.asciidoc: 
  line 23: illegal block content outside of partintro block

docs/quickstart.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: Thibault Richard <[email protected]>
Copy link
Contributor

@barkbay barkbay left a comment

Choose a reason for hiding this comment

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

Almost LGTM, as mentioned in some of my comments my recollection is that we should avoid latinisms or the verb "to see", not sure it it are up-to-date recommendations when writing documentation though.

docs/quickstart.asciidoc Outdated Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
docs/quickstart.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: Michael Morello <[email protected]>
@stefnestor
Copy link
Contributor Author

@barkbay latinisms are removed, cheers; any other recommendations from you or @thbkrkr?

Copy link
Contributor

@barkbay barkbay left a comment

Choose a reason for hiding this comment

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

@barkbay latinisms are removed, cheers; any other recommendations from you or @thbkrkr?

I think there are still a few of them introduced in this PR (~10 via for example). As I said we used to avoid and remove them, I can't tell if we still want to apply this practice in our documentation though.

LGTM otherwise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs Documentation >enhancement Enhancement of existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants