Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

README.md

Getting Started

Prerequisites

  1. Verify python 3 and python-pip are installed. 
    python3 --version pip3 --version

Install mkdocs

  1. If you intend to contribute changes and you do not have commit privileges for the openboxes/openboxes project, create a fork of the repository and use that. For details, see Contributing.

  2. Clone the repository.

    git clone git@github.com:openboxes/openboxes.git cd openboxes

  3. Create a Python environment in this cloned repo.

    pip3 install virtualenv mkdir python virtualenv python # create a python env in the python subdir with bin, lib subdirs source python/bin/activate # configure shell session for this python env which pip # confirm that we are now running in the virtual env

  4. Install required mkdocs dependencies in this env.

    pip install -r docs/requirements.txt

Build the docs and run a local server.

  1. Run the mkdocs server 
    mkdocs serve &
  2. Open docs in browser

Contributing

  1. Create a new branch for your documentation changes
git checkout -b docs/1234-fix-typo

Tip

Branching naming should follow convention above. If possible, use the GitHub issue number and summary in your branch name.

  1. Make documentation changes in an editor of your choice
  2. Commit changes to branch with meaningful commit message
git commit -m "#1234: fixed typo in docs"
  1. Push changes to GitHub
  2. Create a pull request
  3. Assign jmiranda as a reviewer