Repository files navigation

Repository fordocs.localstack.cloud.

LocalStack Docs is using the following technology stack:

• Hugo to generate the static site.
• Docsy as a theme for Hugo.
• GitHub Pages to automatically deploy every commit on themain branch of this repository ondocs.localstack.cloud.

Clone this repository and initialize the Git submodules recursively (themes/docsy is a submodule that again has submodules for vendored assets like fontawesome).

git clone --recurse-submodules --depth 1 git@github.com:localstack/docs.git

This performs a shallow clone, which leads to only the main branch being configured for your remote.To be able to pull/push from/to all branches, please run:

git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*" && git fetch

or:

git clone git@github.com:localstack/docs.gitcd docsgit submodule update --init --recursive

LocalStack Docs is based on theHugo static site generator.

In order to contribute to LocalStack Docs, you need toinstall Hugo in order to verify your changes.Make sure to install theextended version of Hugo.You also need to make sure thatgo is installed in order to run hugo scripts.

Once you have Hugo installed, you can start your local server with the following command:

hugo serve

or run in developer mode with automatic reload:

hugo serve --watch=true --disableFastRender -D

Once the server is started, the locally served Docs are available athttp://localhost:1313.

The whole site is generated with Hugo, a powerful static-site generator.

You can find an extensive documentation on how to use Hugoin their docs, however most of the content is written in plain Markdown.

Make sure to follow the best practices below when contributing content.

While contributing to the developer hub applications page i.e. editingdata/developerhub/applications.json file, make sure to run thecreate-applications.js script in thescripts folder to create new application pages.

Example usage in the project root:

node scripts/create-applications.js

You can run pre-commit checks to ensure that your changes are compliant with the repository's standards.

pip install pre-commitpre-commit install

pre-commit will run automatically before each commit.If you want to run it manually, usepre-commit run.

Please follow these best practices when writing documentation in this repository:

• Stick to markdown wherever possible.

• One sentence per line: Use one line for each sentence in markdown.Unless you add a backslash at the end of the line or add two new-lines, there won't be linebreak in the rendered text.

• Commands: Use thecommand shortcode for all one-line commands (also when their output is presented).Do not use it for bash scripts with comments.You can find a more detailed description here:localstack#55.If needed, you can alsohighlight a specific line.

• Internal links: Use theref orrelref shortcode when creating non-external links (but still use the markdown native image linking, ref doesn't work there).You can either useref orrelref, the point is to have compile time internal-link checks (which works for both).

• Code snippets: For snippets, make sure you indicate the programming/markup language so that proper syntax highlighting is used.Usebash only for Bash scripts, and usetext for shell outputs or command examples.The full list of the supported languageshere.If needed, you can alsohighlight a specific line in the snippet.

• Images: If you want to use images in your post, create a newleaf bundle directory and put the image and the post (namedindex.md) in there (you can find examples in the docs already, f.e.the cognito service docs).Then you can use the usual markdown syntax with a relative path (f.e.:![Alternative_Text](file_next_to_post.png)).If you want to resize the image, use thefigure orimg shortcode, for example:{{< img src="cockpit-init-check.png" width="150px" >}}

• Callouts: Use these to make content stand out.Thecallout shortcode supportsnote (default),tip andwarning levels.Use it like so:

  {{< callout "warning" >}}This will make your computer halt and catch fire!{{< /callout >}}

This section covers common issues when working with LocalStack Docs:

Example error:

Start building sites …hugo v0.88.1-5BC54738+extended linux/amd64 BuildDate=2021-09-04T09:39:19Z VendorInfo=gohugoioError: Error building site:"/home/localstack/Repos/docs-test/content/en/get-started/_index.md:57:1": failed to extract shortcode: templatefor shortcode"alert" not foundBuiltin 45 ms

1. Make sure to correctly clone and initialize the git submodules of this repo.For details see the section "Clone the repo" above.
2. Delete the Hugo Module cache usinghugo mod clean ormake clean.