https://github.com/glueops/getoutline-docs-update-github

This repository generates dynamic documentation for GitHub organizations and updates GetOutline.com with these details. It simplifies discovery and search within GetOutline. Built with Python, it uses Docker for containerized deployment and requires specific environment variables for configuration.
https://github.com/glueops/getoutline-docs-update-github

api automation docker documentation getoutline github github-api markdown python

Last synced: 26 days ago
JSON representation

This repository generates dynamic documentation for GitHub organizations and updates GetOutline.com with these details. It simplifies discovery and search within GetOutline. Built with Python, it uses Docker for containerized deployment and requires specific environment variables for configuration.

• Host: GitHub
• URL: https://github.com/glueops/getoutline-docs-update-github
• Owner: GlueOps
• Created: 2024-11-21T07:19:23.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-05T04:32:15.000Z (29 days ago)
• Last Synced: 2024-12-08T05:06:49.108Z (26 days ago)
• Topics: api, automation, docker, documentation, getoutline, github, github-api, markdown, python
• Language: Python
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

2. 

    ```sh

    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:

```env

export GITHUB_TOKEN= #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=

export GETOUTLINE_API_TOKEN=

```