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

Make the snippets more "asciidoctor" standard #46189

Closed
nik9000 opened this issue Aug 30, 2019 · 5 comments
Closed

Make the snippets more "asciidoctor" standard #46189

nik9000 opened this issue Aug 30, 2019 · 5 comments
Assignees
Labels
>docs General docs changes Meta

Comments

@nik9000
Copy link
Member

nik9000 commented Aug 30, 2019

This is to track the cleanup that we can do to the docs after #46180 and #45937. That is:

  1. On console snippets we can
  2. Replace [source,js] with [source,console]
  3. Remove // CONSOLE
  4. On console response snippets we can
  5. Replace [source,js] with [source,console-result]
  6. Remove // TESTRESPONSE if it doesn't have any special operations like s

The first on is nice because it makes the docs consistent with how they actually work in Asciidoctor. The second one does that too but also will allow clients to override those snippets when they are overriding request snippets.

@nik9000 nik9000 added >docs General docs changes Meta labels Aug 30, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@nik9000
Copy link
Member Author

nik9000 commented Aug 30, 2019

@jrodewig started this with #46159.

@jrodewig
Copy link
Contributor

jrodewig commented Sep 3, 2019

#46295 switches all the // TESTRESPONSE comments over.

@jrodewig
Copy link
Contributor

jrodewig commented Sep 6, 2019

Once #46353 and #46440 are merged, we can consider this near complete.

However, there are likely pending PRs that still contain the old magic comments.

@nik9000 Are we planning to remove support for those magic comments? If so, we may want to do a coordinated "final cleanup" right beforehand. We'd also want some way to address pending PRs that have already passed CI but would fail in production if support was removed.

All that is moot if we want to continue supporting both.

@jrodewig
Copy link
Contributor

Closing this as #46936 ends support for // CONSOLE in the master and 7.x branches.

7.4 acts as a 'bridge' branch where both [source,console] and // CONSOLE are supported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Meta
Projects
None yet
Development

No branches or pull requests

3 participants