-
Notifications
You must be signed in to change notification settings - Fork 109
docs: Polish README with corrections and helpful guides #457
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
Open
KushguptaPST
wants to merge
1
commit into
volcano-sh:master
Choose a base branch
from
KushguptaPST:fix-readme-improvements
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,8 +11,8 @@ is an open-source static site generator that provides us with templates, content | |
| organisation in a standard directory structure, and a website generation engine. | ||
| You write the pages in Markdown, and Hugo wraps them up into a website. | ||
|
|
||
| * Please see [How to contributing](https://github.com/volcano-sh/volcano/blob/master/contribute.md) for instructions on how to contribute, if you are not familiar with the | ||
| GitHub workflow | ||
| * Please see [How to contribute](https://github.com/volcano-sh/volcano/blob/master/contribute.md) for instructions on how to contribute, if you are not familiar with the | ||
| GitHub workflow. | ||
|
|
||
| ## Quickstart | ||
|
|
||
|
|
@@ -23,7 +23,7 @@ updates: | |
| 1. Fork the repo on GitHub. | ||
| 1. Make your changes and send a pull request (PR). | ||
| 1. If you're not yet ready for a review, add a comment to the PR saying it's a | ||
| work in progress or add `[WIP]` in your PRs title. You can also add `/hold` in a comment to mark the PR as not | ||
| work in progress or add `[WIP]` in your PR's title. You can also add `/hold` in a comment to mark the PR as not | ||
| ready for merge. (**Don't** add the Hugo declarative "draft = true" to the | ||
| page front matter, because that will prevent the auto-deployment of the | ||
| content preview described in the next point.) | ||
|
|
@@ -35,38 +35,62 @@ updates: | |
| 1. When you're ready for a review, add a comment to the PR and assign a | ||
| reviewer/approver. | ||
|
|
||
| ## Project Structure | ||
|
|
||
| * **/content**: Contains the markdown files for the website content. | ||
| * **/static**: Contains static assets like images, CSS, and JavaScript. | ||
| * **/themes**: Contains the Hugo themes used for the website. | ||
| * **/layouts**: Contains custom HTML templates. | ||
| * **/config**: Contains Hugo configuration files. | ||
|
|
||
| ## Previewing your changes on a local website server | ||
|
|
||
|
|
||
| If you'd like to preview your doc updates as you work, you can install Hugo | ||
| and run a local server. This section shows you how. | ||
|
|
||
| ### Install Hugo | ||
|
|
||
| See the [Hugo installation guide][hugo-install]. Here are some examples: | ||
|
|
||
| #### Mac OS X: | ||
|
|
||
| ``` | ||
|
|
||
| See the [Hugo installation guide][hugo-install]. We recommend installing the extended version of Hugo. | ||
|
|
||
| > **Note:** The `netlify.toml` file specifies the Hugo version used for production builds. For local development, it is generally safe to use a newer version, but if you encounter issues, try matching the version in `netlify.toml`. | ||
|
|
||
| #### Mac OS X | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ```bash | ||
| brew install hugo | ||
| ``` | ||
|
|
||
| #### Debian: | ||
|
|
||
| 1. Download the Debian package from the [Hugo website][hugo-install]. | ||
| Make sure to install the Hugo version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L6) file. | ||
| For example, [hugo_0.57.2_Linux-64bit.deb][hugo_0.57.2_Linux-64bit.deb]. | ||
|
|
||
| #### Windows | ||
|
|
||
| **Using Chocolatey:** | ||
| ```bash | ||
| choco install hugo-extended | ||
| ``` | ||
|
|
||
| **Using Scoop:** | ||
| ```bash | ||
| scoop install hugo-extended | ||
| ``` | ||
|
|
||
| Alternatively, download the executable from the [Hugo Releases page](https://github.com/gohugoio/hugo/releases). | ||
|
|
||
| #### Linux (Debian/Ubuntu) | ||
|
|
||
| 1. Download the Debian package from the [Hugo releases page](https://github.com/gohugoio/hugo/releases). Look for the `hugo_extended_<VERSION>_Linux-64bit.deb` file. | ||
| 1. Install the package using `dpkg`: | ||
|
|
||
|
|
||
| ```bash | ||
| sudo dpkg -i hugo_extended_<VERSION>_Linux-64bit.deb | ||
| ``` | ||
| sudo dpkg -i hugo_0.57.2_Linux-64bit.deb | ||
| ``` | ||
|
|
||
|
|
||
| 1. Verify your installation: | ||
|
|
||
| ``` | ||
| ```bash | ||
| hugo version | ||
| ``` | ||
|
|
||
|
|
||
| ### Run a local website server | ||
|
|
||
| Follow the usual GitHub workflow to fork the repo on GitHub and clone it to your | ||
|
|
@@ -88,13 +112,22 @@ local machine, then use your local repo as input to your Hugo web server: | |
| 1. Your website is at [http://localhost:1313/](http://localhost:1313/). | ||
|
|
||
| 1. Continue with the usual GitHub workflow to edit files, commit them, push the | ||
| changes up to your fork, and create a pull request. (See the GitHub workflow) | ||
| changes up to your fork, and create a pull request. | ||
|
|
||
| 1. While making the changes, you can preview them on your local version of the | ||
| website at [http://localhost:1313/](http://localhost:1313/). Note that if you | ||
| have more than one local git branch, when you switch between git branches the | ||
| local website reflects the files in the current branch. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| * **Port already in use**: If you see an error about port 1313 being in use, you can specify a different port: | ||
| ```bash | ||
| hugo server -D -p 1314 | ||
| ``` | ||
| * **Changes not showing**: Ensure you are editing the file in the correct language folder (e.g., `content/en/`). | ||
| * **Draft content**: If you created a new page, make sure `draft: true` is not set in the front matter, or run hugo with `-D`. | ||
|
|
||
| Useful Hugo docs: | ||
| - [Hugo installation guide](https://gohugo.io/getting-started/installing/) | ||
| - [Hugo basic usage](https://gohugo.io/getting-started/usage/) | ||
|
|
@@ -103,4 +136,10 @@ Useful Hugo docs: | |
| - [hugo new reference](https://gohugo.io/commands/hugo_new/) | ||
|
|
||
| [hugo-install]: https://gohugo.io/getting-started/installing/ | ||
| [hugo_0.57.2_Linux-64bit.deb]: https://github.com/gohugoio/hugo/releases/download/v0.57.2/hugo_0.57.2_Linux-64bit.deb | ||
|
|
||
| ## Getting Help | ||
|
|
||
| If you need help, feel free to reach out to the Volcano community: | ||
|
|
||
| * [Slack](https://cloud-native.slack.com/archives/C011GJDQS0N) | ||
| * [Mailing List](https://groups.google.com/forum/#!forum/volcano-sh) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and to follow common Markdown conventions for file paths, consider using backticks to format the directory names as code. This will also make them stand out more clearly as paths. The glob-like
**/prefix seems unnecessary here as these are top-level directories.