website icon indicating copy to clipboard operation
website copied to clipboard

Add a "improve these instructions" link

Open pde opened this issue 9 years ago • 7 comments

We should make a page that explains how to file bugs and pull requests against the instruction generator, and link to it from every instructions page.

pde avatar May 12 '16 20:05 pde

Do you envision this as being a page on the certbot site? or like a github .md file or something entirely different I'm happy to write up these instructions, but will likely need help styling them

SwartzCr avatar May 17 '16 18:05 SwartzCr

here's a first stab at the text I think ideally we'd have some images of the code with annotations or like before/afters

Editing the Certbot instructions

Certbot instructions are available for editing as part of the https://github.com/certbot/website repository - if you've found an error or generally think that you can improve them we welcome your support!

Source Files

The files for the instruction generator are in https://github.com/certbot/website/tree/master/_scripts/instruction-widget They're mostly determined by the template files in https://github.com/certbot/website/tree/master/_scripts/instruction-widget/templates which are made up of HTML and mustache.js template commands. Some of the text is set through javascript which can be found here: https://github.com/certbot/website/blob/master/_scripts/instruction-widget/install.js

Editing

Most text is determined by by the HTML in the template files. To edit them you'll need a basic understanding of HTML. Anything inside of {{ example_text }} is a mustache.js template - which documentation can be read about here. Certain variables, such as the specific command to invoke certbot, are determined in install.js and getting-started.js and are set as context elements to go along with the ones determined by the drop down options (defined here: https://github.com/certbot/website/blob/master/_scripts/instruction-widget/data/inputs.json). These allow you to change certain text selectively based on the specific webserver or OS that the user has specified. This means that if there is an error for your specific webserver or OS instructions you should check both the corresponding js file and template for the source of that error.

SwartzCr avatar May 18 '16 00:05 SwartzCr

This should probably be added to the footer that @jpt made with the links to docs github and LE, and thus maybe Tribby should own it

SwartzCr avatar Jun 01 '16 18:06 SwartzCr

for now maybe it can just link to the source directory for the instruction generator on github until we get a dedicated page

SwartzCr avatar Jun 01 '16 18:06 SwartzCr

Or it could just say to open an issue and link to certbot/website/issues

SwartzCr avatar Jun 01 '16 18:06 SwartzCr

@schoen would you be willing to provide feedback on the instruction text above?

SwartzCr avatar Jun 10 '16 22:06 SwartzCr

@jpt would you be willing to add a link at the bottom of the instruction generation site to https://github.com/certbot/website/blob/master/EDITING.md such that it shows up for all generated instructions?

SwartzCr avatar Sep 08 '16 18:09 SwartzCr