Skip to content

Explore Github Pages for hosting the guide website #2

Closed

Description

@GBKS

There are several advantages to hosting the site via Github pages:

  • Integrated with the Github collaboration tools
  • Automatically reflects the latest codebase without any complex deploy processes
  • Easy to configure due to Jekyll integration
  • Integration with third-party tools like Transifex for localization

There are some known basics we can already explore (templating, search function, localization), but we will have to wait for the content and design to progress further to really know what all of our requirements are. We can either keep this issue open, or focus it on the basics and create more issues for future improvements.

References:
Github pages marketing page
Screencasts by Christoph

Activity

  1. pedromvpg commented on Jul 12, 2020

    @pedromvpg
    Collaborator

    Some more progress done here:
    https://pedromvpg.github.io/bitcoin-design-guide/

    More structure, homepage, search, and more.

    Still not going too much into design as I want to make sure this offers all the functionality we need and I also want to make sure we jumpstart the project with a more barebones/wireframy look and feel so the visual ui can emerge and evolve with the content of the guide.

  2. GBKS commented on Jul 24, 2020

    @GBKS
    ContributorAuthor

    I believe we can safely assume that everybody is on board with this proposal. I'll close this issue on Monday, July 27, if there are no further comments.

  3. ConorOkus commented on Jul 24, 2020

    @ConorOkus
    Collaborator

    Happy to go with this, I would like us to look into if it's possible to do PR builds. So opening a pull request creates a "preview" version of the site so people reviewing can see the content on the site and not just in markdown.

  4. johnsBeharry commented on Jul 24, 2020

    @johnsBeharry
    Contributor

    @ConorOkus PR Commits can actually be easy if the forker has GitHub pages also enabled for their repo. Once the links resolve properly. Can be something added to the CONTRIBUTING.md

  5. GBKS commented on Jul 27, 2020

    @GBKS
    ContributorAuthor

    @johnsBeharry that only works for forks and not for branches, right?

  6. pedromvpg commented on Jul 27, 2020

    @pedromvpg
    Collaborator
  7. GBKS commented on Jul 28, 2020

    @GBKS
    ContributorAuthor

    @pedromvpg that seems like feature by Netlify, no? So Github doesn't support it by default, but you can use Netlify to make it happen? Totally fine with me if that's the case.

  8. added a commit that references this issue on Aug 6, 2020
  9. GBKS commented on Oct 21, 2020

    @GBKS
    ContributorAuthor

    Pretty sure we can consider this one done for now. We are using Github Pages. Any changes can be discussed in new issues.

  10. added a commit that references this issue on Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions