Skip to content

Docs: Drop inline callouts #1270

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 3, 2019
Merged

Docs: Drop inline callouts #1270

merged 2 commits into from
Apr 3, 2019

Conversation

nik9000
Copy link
Member

@nik9000 nik9000 commented Apr 3, 2019 •
edited
Loading

Drops the inline callouts from the docs. This is when you write <1>
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.

I've taken a shot at removing all of the callouts and everything
compiles but I suspect it doesn't look quite right.

Closes #1262

@nik9000
Docs: Drop inline callouts
36b9a98 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.

I've taken a shot at removing all of the callouts and everything
compiles but I suspect it doesn't look quite right.
@nik9000 nik9000 added the >docs label Apr 3, 2019
@nik9000 nik9000 requested a review from jbaiera April 3, 2019 18:38
@nik9000
Copy link
Member Author

nik9000 commented Apr 3, 2019

@jbaiera, I converted all of the inline callouts into non-inline callouts but I don't know that I preserved the accuracy of the examples. Could you have a look?

You can now build the docs with ../docs/build_docs --doc docs/src/reference/asciidoc/index.adoc --asciidoctor --out ../built_docs --open. They build about 3x faster with --asciidoctor and that is what we're trying to move towards. It will fail to build if it hits any inline callouts.

@nik9000 nik9000 mentioned this pull request Apr 3, 2019
Merged
@nik9000
Copy link
Member Author

nik9000 commented Apr 3, 2019

@jbaiera these are the branches that need to have this change:

[ master, 7.x, { 7.0: 7.0.0-rc2 }, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0 ]

Which is a whole bunch. Sorry about that.....

@nik9000 nik9000 mentioned this pull request Apr 3, 2019
Closed
jbaiera
jbaiera approved these changes Apr 3, 2019
View reviewed changes
Copy link
Member

@jbaiera jbaiera left a comment

Choose a reason for hiding this comment

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

LGTM Thanks @nik9000 for getting this started. I'll find some gloves and start the messy work of backporting this tomorrow.

@jbaiera jbaiera merged commit 4de58b5 into master Apr 3, 2019
@jbaiera jbaiera deleted the docs_drop_inline_callouts branch April 3, 2019 20:58
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
ff91d11 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
fcecc7b 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
fcdb94d 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
ee15503 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
ca79e70 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
b6814df 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
a8f9698 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
a504610 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
a219fbc 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
8f97a98 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
8c1a871 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
853026c 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
6d9b0ac 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
69e6a7c 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
52102ca 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
420d291 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
3d612a8 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
33664b2 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
2b34a38 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
1a62cd7 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
0345dfc 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
jbaiera pushed a commit that referenced this pull request Apr 5, 2019
@nik9000 @jbaiera
Docs: Drop inline callouts (#1270)
f449fd4 
Drops the inline callouts from the docs. This is when you write `<1>`
anywhere but the end of a line. Asciidoctor doesn't support them and
we'd very much like to move to Asciidoctor to generate the docs because
it is being actively maintained.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jbaiera jbaiera jbaiera approved these changes

Assignees
No one assigned
Labels
>docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nik9000 @jbaiera