https://github.com/bhacaz/our-docs

Serve documentation (static website) behind Github authentification
https://github.com/bhacaz/our-docs

Last synced: about 2 months ago
JSON representation

Serve documentation (static website) behind Github authentification

• Host: GitHub
• URL: https://github.com/bhacaz/our-docs
• Owner: Bhacaz
• Created: 2021-10-01T23:22:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-06T00:40:27.000Z (over 3 years ago)
• Last Synced: 2024-10-09T03:21:01.468Z (3 months ago)
• Language: Ruby
• Size: 76.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Our Docs

Serve documentation (static when site) behind a GitHub authentication. 

## Why

Netlify, Vercel, GitHub Pages or awesome to serve and build static when site.

But there is no easy way to restrict access. Our Docs restriction is basic, if you can

access to GitHub repository, you can access the website.

## How it works

### Adding documentation to Our Docs

1. Install the GitHub app `Our Docs` to a repository.

2. Go to <> and Login to your GitHub account.

3. Select **Add Docs**

4. Select the repo and specify a branch where your static documentation will be.

5. Click to **Go to Our Docs**

### Building your documentation

Our Docs was thinking to let you handle the techno to build and generate your documentation. Our Docs will received

webhooks when the specified branch received new commit.

#### Example

* Create a new project with [Jekyll](https://jekyllrb.com/)

* Push it to GitHub

* Setup an GitHub action to build your static website. [Details](https://jekyllrb.com/docs/continuous-integration/github-actions/).

* Configure the action to push on the branch choose in Our Docs.

## Development

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...