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

escape $$ in asciidoc when generating api-reference pages #17298

Merged

Conversation

caesarxuchao
Copy link
Member

Fix #17155 on head.

cc @orfjackal

@caesarxuchao caesarxuchao changed the title escape 23550 in asciidoc when generating api-reference pages escape $$ in asciidoc when generating api-reference pages Nov 15, 2015
@@ -50,11 +50,11 @@ SWAGGER_PATH="${REPO_DIR}/api/swagger-spec/"

echo "Reading swagger spec from: ${SWAGGER_PATH}"

docker run -u $(id -u) --rm -v $V1_TMP_IN_HOST:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \
docker run -u $(id -u) --rm -v $V1_TMP_IN_HOST:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4.1 \
Copy link
Member Author

Choose a reason for hiding this comment

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

Just pushed the v4.1 image to gcr.io.

@k8s-github-robot
Copy link

Labelling this PR as size/S

@k8s-github-robot k8s-github-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 15, 2015
@k8s-bot
Copy link

k8s-bot commented Nov 15, 2015

GCE e2e build/test failed for commit 2c61291372005274a367f7ab4212d51dbcc9d4b7.

@caesarxuchao caesarxuchao assigned nikhiljindal and unassigned thockin Nov 17, 2015
@@ -53,6 +53,9 @@ sed -i -e 's|<<any>>|link:definitions.html#_any[any]|g' ./paths.adoc
# change the title of paths.adoc from "paths" to "operations"
sed -i 's|== Paths|== Operations|g' ./paths.adoc

# $$ has special meaning in asciidoc, we need to escape it
sed -i 's|\$\$|+++$$+++|g' ./definitions.adoc
Copy link
Contributor

Choose a reason for hiding this comment

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

Who does the unescaping? (Removing +++)

Copy link
Member Author

Choose a reason for hiding this comment

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

asciidoctor does that 2 lines later.

@nikhiljindal nikhiljindal added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 18, 2015
@nikhiljindal
Copy link
Contributor

LGTM, modulo a clarifying question

@caesarxuchao
Copy link
Member Author

@k8s-bot test this please

@k8s-bot
Copy link

k8s-bot commented Nov 18, 2015

GCE e2e build/test failed for commit 2c61291372005274a367f7ab4212d51dbcc9d4b7.

@caesarxuchao
Copy link
Member Author

@k8s-bot test this please

@k8s-bot
Copy link

k8s-bot commented Nov 18, 2015

GCE e2e build/test failed for commit 2c61291372005274a367f7ab4212d51dbcc9d4b7.

@caesarxuchao
Copy link
Member Author

@k8s-bot test this please

@k8s-bot
Copy link

k8s-bot commented Nov 18, 2015

GCE e2e test build/test passed for commit 2c61291372005274a367f7ab4212d51dbcc9d4b7.

@k8s-github-robot k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 20, 2015
@wojtek-t
Copy link
Member

@caesarxuchao - please rebase

@k8s-github-robot
Copy link

PR changed after LGTM, removing LGTM.

@k8s-github-robot k8s-github-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2015
@caesarxuchao caesarxuchao added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2015
@caesarxuchao
Copy link
Member Author

Adding back the LGTM after rebase. Thank you @wojtek-t for the reminder.

@k8s-github-robot k8s-github-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 23, 2015
@k8s-bot
Copy link

k8s-bot commented Nov 23, 2015

GCE e2e test build/test passed for commit 099855d7a702bdd06b23d2bfa73bae8cef4ee3e5.

@nikhiljindal
Copy link
Contributor

@caesarxuchao Jenkins is failing with 10:01:43 /workspace/kubernetes/docs/api-reference is out of date. Please run hack/update-api-reference-docs.sh, can you please take a look

@caesarxuchao
Copy link
Member Author

Thanks. It should be fixed now.

@k8s-github-robot
Copy link

PR changed after LGTM, removing LGTM.

@k8s-github-robot k8s-github-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2015
@k8s-bot
Copy link

k8s-bot commented Nov 23, 2015

GCE e2e test build/test passed for commit 21d8ad3.

@nikhiljindal nikhiljindal added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2015
@k8s-github-robot
Copy link

Automatic merge from submit-queue

k8s-github-robot pushed a commit that referenced this pull request Nov 24, 2015
@k8s-github-robot k8s-github-robot merged commit c4bedfb into kubernetes:master Nov 24, 2015
zmerlynn added a commit that referenced this pull request Dec 4, 2015
shyamjvs pushed a commit to shyamjvs/kubernetes that referenced this pull request Dec 1, 2016
shouhong pushed a commit to shouhong/kubernetes that referenced this pull request Feb 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants