hev / enterprise-docs

Source for the Anchore Enteprise Docs site

Enterprise Documentation

This is the repository for the Anchore Enterprise Documentation site.

Filing Bugs/Issues:

See Issues

Contributing

See Contributing for the DCO and sign-off information. In short, sign all commits with 'Signed-off-by X' with git commit -s.

Making Changes/Contribution Workflow

1. Fork the repository

2. Install hugo-extended, this is necessary because the docsy theme uses some scss functionality only in the extended version.

3. Install 'postcss-cli' and 'autoprefixer' using npm: npm install

4. Clone the forked repo locally, with submodules to ensure the theme is available: git clone --recurse-submodules https://github.com/<your_repo>

If you cloned already, then update the submodules with: git submodule update --init --recursive

1. Run hugo for local debugging/dev: cd enterprise-docs ; hugo server

2. Make changes

3. Commit and push

4. Open PR to github.com/anchore/enterprise-docs for merge to master