Skip to content

Latest commit

 

History

History
140 lines (96 loc) · 2.89 KB

README.md

File metadata and controls

140 lines (96 loc) · 2.89 KB
Raw

AsTeRICS Docs

Documentation of AsTeRICS.

GitHub Workflows

This repository provides following workflows:

NOTE: Workflow Release runs Algolia after building the website automatically. Don't run workflow Algolia after running Prerelease since it won't have any effect. When running workflow Algolia manually, enable deletion of the previous index to avoid execeeding the allowed amount of index records.

Algolia

To update the search index of Algolia manually, run following command:

docker run -it --env-file=.env -e "CONFIG=$(cat ./src/vuepress/config/algolia.json | jq -r tostring)" algolia/docsearch-scraper

To run this command, you need following tools installed: docker, jq. Additionally, create a file .env and specify following variables:

APPLICATION_ID=<APP_ID>
API_KEY=<API_KEY>

Dependencies

Install needed dependencies with

yarn install

Release Instructions

TODO: Write instructions

Usage Instructions

Setup asterics-docs using the provided docs tools (cf. DOCS Reference)

# Initialize asterics-docs
$ yarn docs init

# Deinitialize asterics-docs
$ yarn docs deinit

# Setup docs folder
$ yarn docs setup

Change and edit files

# Show status
$ yarn docs status

Update changes

# Add files for commit
$ yarn docs add <file|folder> [<file|folder> ...]

# Commit files
$ yarn docs commit

# Push changes to origin
$ yarn docs push

NOTE: You can inspect and add files without the docs tool using git in folder setup by the tool.

Configuration Reference

Use variables in file .env to configure the builds

# Deployment
## Host IP address
HOST="127.0.0.1"

## Host port number
PORT=8000

## Path to documentation on server
ENDPOINT="docs"

# docs tool
AUTHOR="Max Mustermann <m.mustermann@github.com>"
COMMITTER="Madeleine Musterfrau <m.musterfrau@github.com>"

DOCS Reference

Start docs tool using yarn:

yarn docs <command>

For detailed instructions use:

yarn docs <command> --help

DOCS Commands

# Main
yarn docs init
yarn docs setup
yarn docs add
yarn docs commit
yarn docs push

# Supplementary
yarn docs status
yarn docs index
yarn docs convert

TODO

  • yarn docs index: user selected entries
  • yarn docs pull: basic functionality
  • yarn docs push: credential handling
  • yarn docs build/devel: required?
  • config.js: VERSION mappings