[DOCS] Reformat get snapshot lifecycle policy API docs #47827
Conversation
jrodewig
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-core-features (:Core/Features/ILM+SLM) |
| the get snapshot lifecycle policy API. This also includes information about the | ||
| latest successful and failed invocation that the automatic snapshots have taken. | ||
| Returns information | ||
| about one or more snapshot lifecycle policies. |
There was a problem hiding this comment.
What is up with the ~50 character line wrapping?
There was a problem hiding this comment.
That's my attempt to use something similar to semantic line breaks:
https://sembr.org/
I'm using it a bit looser here as "Returns information" is sort of a generic start we use for more get API documentation.
Let me know if you think it makes think more difficult to review, etc.
There was a problem hiding this comment.
I think it makes it much harder to review, but that may be just my personal preference.
There was a problem hiding this comment.
I also think it ends up getting reversed in most cases (for instance, I usually use a re-flowing tool or par when I update docs)
There was a problem hiding this comment.
Thanks for the feedback!
|
|
||
| [source,console] | ||
| -------------------------------------------------- | ||
| GET /_slm/policy | ||
| -------------------------------------------------- | ||
| // TEST[continued] | ||
|
|
||
|
|
There was a problem hiding this comment.
Do we need double spacing between things for an asciidoctor reason?
There was a problem hiding this comment.
I chiefly do this to better indicate breaks between sections. It has no impact on the final output.
|
Thanks for your review @dakrone. If wanted, I can update this PR to keep most of the original wording and simply implement the new headings, etc. I'm not trying to rob the docs of their character. 😄 |
That's up to the docs team, I understand if they want them in a certain voice. :) |
Updates the get snapshot lifecycle policy API docs to align with the new API reference template.
Relates to elastic/docs#937 and #45620