certbot / website Goto Github PK

View Code? Open in Web Editor NEW

60.0 21.0 166.0 3.66 MB

The code for the Certbot instruction generator and documentation

Home Page: https://certbot.eff.org

certbot javascript html

website's Introduction

Certbot Website

This website is now internally maintained.

Editing content

Please suggest content changes on Mattermost or via an issue in Github.

Hosting providers list

If you notice information that’s out of date or incorrect, submit a pull request to our website’s Github repo. Make sure to check out tips for successfully editing the hosting providers list.

Make sure to fill out the name, link, category, and reviewed fields.
reviewed should be a date in format 2019.7.11.
link is usually a link to the provider's main page; it's where clicking on the name will go.
for category, see descriptions here.
for full/partial categories, one of the links provided should have evidence of being in that category.
only one of tutorial, announcement, plan will show up, in that order.
partial should have tutorial.
full providers shouldn't need a tutorial to turn on https. an exception might include instructions of what to do if something goes wrong and the automatic https doesn't work.
if one provider offers multiple products, either split into two entries or note it in the note field.
the note field is good for things like noting which products have https, or that the site is available only in certain languages. it's not meant for advertising.
all unused fields should be ""

website's People

Contributors

Stargazers

Watchers

Forkers

vbrown608 iblech brchristian hlieberman mfb pconrad-fb xgin maxfalstein cowlicks cameronbriar sbraz kleopatra999 abduelhamit alexxnica mikejamesthompson kryndex jmorahan muhammednagy ohemorange tommietheturtle tjsoftworks zjs tchollingsworth davidjb bmw daniel15 ufhh01 imgbotapp acidburn0zzz jsoref zijie98 th0114nd zaiwang ykankaya collinanderson esoterik mfrigillana adferrand jacklicn bhanditz u436752457 tabp0le alexkingnz ari-gold keiko713 jsamuel cscott michielbdejong hellrazor6666 jessuppi ptoone olvikolvi jeffreylees nathanfeeser wetopi masterscott louis-berruyer rudloff temandroid 1984hosting pgporada whmpress m4dz veroservers rlaager tylampella alpha14 icdsoftware spacecodeit netwarex ciscllc ramalmaty wsheffel radeknoone alexzorin m1group jonashrem simonvik emilstahl zieva iyared underdarknl kden stoebern shellrent sydboys yosatak tremhost linuxwizard sebastienreuiller reupke u3546273 https-github-com-ole-h conetix bakuhosting sitedata anurag-sonkar harsh2699 prk-m sandipankarmakar04

website's Issues

<pre> formatted text has an unecessary horizontal scrollbar

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

Jekyll watch symlink error

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

Add a warning CSS style

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.

Add link to Lets Encrypt on the page

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

Generate no-js instruction page on site build

Docs nits

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

Fix favicon

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

Load widget js on front page only

Review for Final Styling Changes

Deploy script needs to be written and documented

for internal use by people who will be updating the website

Heading hierarchy tweaks

-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.

Build tabbed layout for instruction generator

banner image gets stretched on other sections of the site

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

Add <link> to cbtheme.css in docs headers

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

Get a staging copy of this script to run on a website

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

Docs should link back to certbot website

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

docs: change View page source link to Edit on GitHub link

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

FAQ needs the right copyright

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.

Final FAQ language and doc copyright needs to be fixed

Finalise subtitle text

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...

Ubuntu 15.10 PPA?

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

Build PDF, HTML zip and Epub versions of docs

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

Easier linking to specific instructions

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.

Add anon-stats analytics support

Website typo walkthrough

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

add license to this repo

docs color scheme

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.

Set up javascript sourcemaps

Add a command to reload submodules to deploy script

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

Ensure that the docs are Updated on Build

MVP of instruction generator

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

Images in the bottom of the page should be in the instruction widget

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

Keep instructions in sync with package name transitions

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?

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 :)