Skip to content
This repository was archived by the owner on Nov 6, 2023. It is now read-only.
This repository was archived by the owner on Nov 6, 2023. It is now read-only.

Use GitHub for documentation instead of eff.org #7256

Closed

Description

@J0WI

While creating #7255 I realized that we have some parts of our docs here on GitHub, some parts on EFF.org and some parts on both.

I think it would be easier to maintain when EFF.org just refers to the docs here on GitHub. To be more specific, I mean the pages "FAQ", "Report Bugs / Hack On The Code" and "Creating HTTPS Everywhere Rulesets". They should be copied into the GitHub Wiki or into the existing .md files.
This would allow contributes to help improving the documentation and update it when core functionality or requirements changed.

cc @jsha @Hainish

Activity

  1. J0WI commented on Oct 1, 2016

    @J0WI
    ContributorAuthor
  2. jeremyn commented on Oct 2, 2016

    @jeremyn
    Contributor

    I strongly support this. Given the options of .md files and the GitHub Wiki, I prefer .md files.

  3. jsha commented on Oct 10, 2016

    @jsha
    Member

    Yep, I am 100% agreed: This repo should be the primary source material for the documentation. However, I think the EFF website is a friendlier place to offer the documentation to end users. @J0WI pointed out docs/rulesets.html. I created that from the content on https://www.eff.org/https-everywhere/rulesets, with the intent that we edit it here, and then someone with EFF edit privs updates it on EFF.org. If you have time to do the same process with additional pages from that site, I'm in support of the idea!

    It may also make sense for the more developer-facing documents to live entirely with the source code, rather than on the web site. That way we could save a step for certain updates.

  4. Hainish commented on Oct 21, 2016

    @Hainish
    Member

    I agree that the repo should be the canonical place for documentation. I think we should convert docs/rulesets.html to markdown, and use pandoc to generate the HTML used on the EFF website.

    Likewise, we should add an FAQ.md and Report_Bugs_Hack_Code.md

  5. Hainish commented on Oct 30, 2016

    @Hainish
    Member

    Related: #7469

  6. Hainish commented on Nov 8, 2016

    @Hainish
    Member

    #7469 closes this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions