Skip to content
ABCI Users Guide & Portal Guide
Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
en
ja Merge pull request #84 from aistairc/201909-python Sep 10, 2019
portal
root
.gitignore
README.md update README.md Jul 7, 2019
site.mk

README.md

README

The primary goal of this project is to organize a concerted community effort to improve the ABCI Users Guide and Portal Guide that explain how to utilize AI Bridging Cloud Infrastructure (ABCI). ABCI is the world's first large-scale Open AI Computing Infrastructure, constructed and operated by National Institute of Advanced Industrial Science and Technology (AIST). We would welcome your feedbacks including pull requests.

On every release we will deploy it as the current official versions of the ABCI Users Guide and Portal Guide, which are located at https://docs.abci.ai/.

Structure of the repository

This repository consists of the following MkDocs documents:

Directory officially deployed URL Notes
root/ https://docs.abci.ai/ Document root of the ABCI User Guide
ja/ https://docs.abci.ai/ja/ Japanese version
en/ https://docs.abci.ai/en/ English version
portal/root/ https://docs.abci.ai/portal/ Document root of the ABCI Portal Guide
portal/ja/ https://docs.abci.ai/portal/ja/ Japanese version
portal/en/ https://docs.abci.ai/portal/en/ English version

Development

You can clone the repository to your local environment and run the builtin development server.

$ pip install mkdocs
$ pip install mkdocs-material==4.3.1
$ git clone https://github.com/aistairc/abci-docs.git
$ cd abci-docs
$ cd root/ or ja/ or en/
$ mkdocs serve

And, open 'http://127.0.0.1:8000/' using a web browser.

Build and deploy

To generate the static versions of documents:

$ make -f site.mk
(static files are generated under site/ directory)

And, to deploy and publish generated documents to gh-pages branch:

$ pip install ghp-import
$ ghp-import -c docs.abci.ai -r origin -b gh-pages -p site
You can’t perform that action at this time.