Skip to content

Commit

Permalink
Add development doc
Browse files Browse the repository at this point in the history
  • Loading branch information
abailly-akamai committed Dec 5, 2023
1 parent f485535 commit cfdfa81
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
source 'https://rubygems.org'

gem 'github-pages', group: :jekyll_plugins
gem "just-the-docs"
gem "just-the-docs", "0.7.0" # pinned to latest release for security purposes

gem "webrick", "~> 1.7"
2 changes: 1 addition & 1 deletion docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ PLATFORMS

DEPENDENCIES
github-pages
just-the-docs
just-the-docs (= 0.7.0)
webrick (~> 1.7)

BUNDLED WITH
Expand Down
19 changes: 19 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Akamai Cloud Manager Documentation

This doc builder uses default GitHub pages and its Jekyll site builder to deploy documentation pages to [https://linode.github.io/manager](https://linode.github.io/manager).

It automatically get deployed when we release to `master`.
It can be customized easily (styles, templates) via updating its configuration and templates (see [documentation](https://just-the-docs.com/docs/configuration))

## Local Development

In order to develop locally, start by setting up your tolling locally by following the steps on this [page](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll).

This should be done from the /docs/ directory.

Once your local site is running, you can:

- modify the styles by updating `_sass/color_schemes/akamai.scss`.
- modify layouts by adding/updating HTML templates to the `_includes` directory.

See [https://just-the-docs.com/docs/customization](https://just-the-docs.com/docs/customization) for mor info.
4 changes: 3 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# CONTRIBUTING is a reserved file name for GitHub, so we need to explicitly include it here
include: ['CONTRIBUTING.md']
# theme: just-the-docs

# Our theme and its customizations
remote_theme: just-the-docs/just-the-docs
color_scheme: akamai
favicon_ico: '/assets/images/favicon.ico'
Expand Down

0 comments on commit cfdfa81

Please sign in to comment.