certbot / website Goto Github PK

so they only get loaded once someone chooses instructions have been chosen, then get replaced by social icons

It would be nice to mockup how the docs should link back to the certbot website.

Currently the docs have their own responsive theme, including hamburger menu for the docs navigation.

So I don't think we want the full certbot navigation bar.

Perhaps we just want a certbot logo linking up one directory?

The actual fix for this would be made in the sphinx theme @ https://github.com/EFForg/sphinx_rtd_theme

colors for the docs subsite can be configured at https://github.com/EFForg/sphinx_rtd_theme/blob/master/sass/_theme_variables.sass

I didn't make any changes here yet but we presumably want to use the same colors as the rest of the certbot site for links, nav menu, etc.

To be closed once we have a generator that has responses for all input options:
remake of: certbot/certbot#2740

In commit 17b073c I added a subtitle to the page, using some horrible CSS hackery. Someone may want to fix that :)

Should we point people towards this or tell them to use *-auto?

Since the FAQ at https://community.letsencrypt.org/t/frequently-asked-questions-faq/26 is CC attribution-NC-sharealike http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US we need to make sure the FAQ on our site (on which the FAQ is based) attributes back to the original FAQ and has the same license.

currently they say that they're licensed to ISRG and are 2014-2015 which is wrong, and it should mention that they're apache licensed

So that we can see what it looks like and play with it.

This is (currently) hardcoded in https://github.com/EFForg/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html

Either a dance, or maybe it should twirl the key

This is a launch blocker

I believe this error is happening because of a symlink in the _docs directory. Doesn't seem to be breaking the build, but it would be nice to handle it better.

Configuration file: /home/vivian/dev/certbot/_config.yml
            Source: /home/vivian/dev/certbot
       Destination: /home/vivian/dev/certbot/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.112 seconds.
        ** ERROR: directory is already being watched! **

        Directory: /home/vivian/dev/certbot/_docs/venv/local/bin

        is already being watched through: /home/vivian/dev/certbot/_docs/venv/bin

        MORE INFO: https://github.com/guard/listen/wiki/Duplicate-directory-errors

The scrollbar should only appear if the text is actually too wide to fit in the user's screen.

• The clean task never actually finishes. Needs to return?
• When running gulp build or gulp watch, there is nothing telling gulp it should finish the clean task before other tasks run. We need to wait for the clean task to finish before other tasks that put stuff in the _site directory start up.
• When running gulp watch we should wait for other tasks to complete before starting jekyll:watch otherwise useless jekyll builds are triggered whenever a file is touched.
• When running gulp watch, there is no callback when the jekyll build completes to tell docs:html it's safe to copy the docs into the _site/docs directory. Therefore gulp watch is currently broken. I haven't thought of a way to fix this (yet :)

Docs should link back to cerbot website
Docs currently say Letsencrypt
Docs copyright is wrong 'letsencrypt 2014-2015'

It's currently the Let's Encrypt logo; we need to make our own.

for internal use by people who will be updating the website

we need to include the cbtheme.css file along with the regular theme file. I'm not clear on where the docs markup is...

Once you've selected both drop-down options on the homepage, the page should scroll to the instructions section, and the URL should change to include the appropriate anchor for those instructions, to make it easy to link people to specific sets of instructions.

we need to ensure that docs are always up to date with certbot/certbot so we need to make sure we're reloading the submodule that includes those docs

One that links directly to letsencrypt.org and one for a donation page

There's work being done towards certbot packages, but will these be available for our next release? If not, we should fix our instructions to continue to point people towards the letsencrypt packages.

There are a few places in advanced instructions where we tell users how to do something dangerous. We should create a warning header style to make sections stand out.

For example cb.org/faq is has a banner that is stretched vertically

We need to add download links for PDF, HTML zip, Epub to the sphinx theme @ https://github.com/EFForg/sphinx_rtd_theme

👞

e.g. currently Ubuntu 16.04 instructions specify to apt-get install certbot but this won't work until the certbot package is actually uploaded.

For each distro (Debian, Fedora, Ubuntu, etc.) we need to update the instructions as package names are updated.

@todo figure out which distros will be updating package names and when? For example, the FreeBSD port?

we should feel confident that there aren't typos on the webpage

Which may require importing some instructions from https://letsencrypt.org/getting-started ?

• add texlive to dependencies for generating PDF files
• add more docs build targets: make -C docs clean html epub latex latexpdf
• use gulp zip to create a zip file from the html build directory

Currently Certbot is the easiest way to get Let's Encrypt certificates; it can optionally autoconfigure HTTPS for you, too. Ideally this would concisely explain:

• Certbot is an ACME client that can obtain certificates from Let's Encrypt (or any other CA that adopts ACME in the future)
• It's EFF's client. Maybe even EFF's official client. It was previously known as the "Let's Encrypt client" or the "Let's Encrypt Python Client"
• It can do this cool thing where it reconfigures your webserver. But only if you want it to. And only if we've implemented and shipped support for your webserver.

Obviously it can't do all of those things...

We could do this either with the HTML5 <aside> tag, or with class=note or something. It should render something vaguely like this.

-FAQ TOC items are too big - need to be distinguished from the FAQ themselves, or removed altogether.
-Headings in the instructions should be closing to the content below them than the content above.

in the sphinx theme @ https://github.com/EFForg/sphinx_rtd_theme