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

Replace content of Build Steps from Json plugin page #219

Open
vihaanthora opened this issue Sep 12, 2022 · 2 comments
Open

Replace content of Build Steps from Json plugin page #219

vihaanthora opened this issue Sep 12, 2022 · 2 comments

Comments

@vihaanthora
Copy link
Contributor

Problem

Build Steps from Json Plugin page currently shows a page that is not rendered correctly by the browser due to the incorrect usage of HTML tags within its asciidoc. The root cause of this issue seems to lie in the help documentation of the plugin itself. However, till the original documentation is fixed, a manually written page could overwrite the contents of the pages, so that anyone who clicks the page sees some usable and well-formatted content.

Possible Fixes

  1. Fix the HTML manually and store it in an asciidoc that is saved in allAscii.zip automatically whenever the pipeline-steps-doc-generator is run.
  2. Replace the entire content with some contextual help and link the instructions to use the snippet generator on this page.

cc: @zbynek @kwhetstone

@vihaanthora vihaanthora changed the title Replace the content of Build Steps from Json Plugin page Replace content of Build Steps from Json plugin page Sep 12, 2022
@timja
Copy link
Member

timja commented Sep 12, 2022

the other approach could be to validate and reject? / validate and fix?

@vihaanthora
Copy link
Contributor Author

Yes, it seems like a good approach to adopt.

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

No branches or pull requests

2 participants