Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/README.md: Improve the Hugo Quick start guide for an easier start #5699

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,6 @@ coverage:
#
project:

#
# Python modules and scripts below scripts/ (excluding tests)
#
scripts:
paths: ["scripts/**", "!**/test_*.py"]
target: 48%
threshold: 2%

#
# Python modules and scripts below ocaml/ (excluding tests)
#
Expand Down
10 changes: 7 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
Quick start guide:

- Visit https://xapi-project.github.io/new-docs/ to view the current documentation.
- Install Hugo; follow the guidance on https://gohugo.io/getting-started/installing.
You'll need Go as well: see https://go.dev/
- On Ubuntu 22.04 and older, use `sudo snap install hugo` to get the needed newer version of `hugo`.
- Run a local server: `hugo server`
- Open a browser at http://127.0.0.1:1313/
- Add some content.
- Open a browser at http://127.0.0.1:1313/new-docs/
- Add content to `doc/content/`:
- Documents are written in Markdown.
- Please wrap lines in paragraphs to make review and diffs easier to read.
- The menu hierarchy comes mostly from the directory structure in `content/`.
- A file called `_index.md` is needed in a directory to define a new level in the menu. Add a title to the frontmatter.
- A file called `_index.md` is needed in a directory to define a new level in the menu.
- To set the page title which is also used for the main menu,
[use the front matter](https://gohugo.io/content-management/front-matter/).
- For a page that has images or other stuff included, it is best to create a new directory. Put the contents in a `index.md` file (no `_`) and the related files next to it. See https://gohugo.io/content-management/organization/ for more information.
- Look at https://mcshelby.github.io/hugo-theme-relearn/ for more information about what the Relearn theme offers, including some handy "shortcodes".
Loading