Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1015 Bytes

README.md

File metadata and controls

27 lines (19 loc) · 1015 Bytes
Raw

getoutline-docs-update-github

Generates dynamic documentation of all our GitHub Organizations and their descriptions and updates GetOutline.com with these details. This makes it easier for discovery and search within getoutline.com

Prerequisites

  • Python (See version in Dockerfile))
  • Docker (optional, for containerized deployment)

Running the app

  1. pipenv install -r requirements.txt
source .env
python app/main.py

Configuration

The application requires three environment variables to be set. You can create a .env file in the root directory of the project with the following content:

export GITHUB_TOKEN=<Uses a PAT> #Assumes that all orgs a user is part of is an ORG that we own. Permissions required: **full** `repo` scope and org `read:org` scope
export GETOUTLINE_DOCUMENT_ID=<This is usually at the end of the document in the URL of the document you want to update>
export GETOUTLINE_API_TOKEN=<Token is tied to a user account in GETOUTLINE>