Create "current" stack version file #1198
Conversation
This file will be useful for books that *generally* want to point the current release of the stack. We'll update it when we release a new version of the stack.
|
@bmorelli25 I've tried to summarize why I think we want this file in the README that I created. @lcawl, we talked a while back about maybe wanting this file. It turns out that @bmorelli25 wants it for APM. If we merge this we really should update the docs release instructions. Could you have a look at this and approve or reject it? |
shared/versions/stack/README
Outdated
|
|
||
| Books outside of the stack have three choices: | ||
|
|
||
| 1. Don't use these versions files at all. |
There was a problem hiding this comment.
Hmmm, I don't think this is really an option any more. With the shared version change, if I want to use any of the shared attributes in the APM Agents, they also have to use the shared version files. An example of why is in the recent ECS PR: #1170.
There was a problem hiding this comment.
So, ok, technically it is an option still. But I would have to start setting attribute values in each of the Agent's index.asciidoc files.
There was a problem hiding this comment.
Maybe I should just drop it from the list then.
|
I don't have a problem with this "current.asciidoc" solution. I think it will still incur some of the usual problems where updating that file will result in broken links, since we invariably have pages that existing in Version X but don't exist anymore in Version X+1. If we can freeze the docs and stage that change to current.asciidoc, it buys us a bit more time to clean up links like that. |
Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
We can delay bumping current.asciidoc if we have to. That'd mean that things outside the stack don't point to the most current version of the stack for a little while. That seems "ok" while we're resolving broken links. |
That sounds reasonable to me. I think we'll also be able to see the full list of broken links in the PR that bumps current.asciidoc, as long as we remember to do a full rebuild test there. |
Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
|
I was also interested in this solution to keep ECK code samples pointing to the current released version of the stack. However, |
I think I just made a mistake there. |
5 participants
This file will be useful for books that generally want to point the
current release of the stack. We'll update it when we release a new
version of the stack.