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

Set docsy version in config as version #1105

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
2 changes: 1 addition & 1 deletion userguide/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ archived_version = false
# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version = "0.0"
version = "0.4.0"
Copy link
Collaborator Author

@chalin chalin Jul 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reusing the version config param. Seems ok in this case.

Also note that I'm leaving this as 0.4.0 since that is the latest official version.


# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
Expand Down
14 changes: 7 additions & 7 deletions userguide/content/en/docs/Updating/Convert-site-to-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Run the following from the command line:
{{< tab header="Unix shell" lang="Bash" >}}
cd /path/to/my-existing-site
hugo mod init github.com/me-at-github/my-existing-site
hugo mod get github.com/google/docsy@v0.4.0
hugo mod get github.com/google/docsy@v{{% param "version" %}}
sed -i '/theme = \["docsy"\]/d' config.toml
cat >> config.toml <<EOL
[module]
Expand All @@ -30,7 +30,7 @@ hugo server
{{< tab header="Windows command line" lang="Batchfile" >}}
cd my-existing-site
hugo mod init github.com/me-at-github/my-existing-site
hugo mod get github.com/google/docsy@v0.4.0
hugo mod get github.com/google/docsy@v{{% param "version" %}}
findstr /v /c:"theme = [\"docsy\"]" config.toml > config.toml.temp
move /Y config.toml.temp config.toml
(echo [module]^
Expand Down Expand Up @@ -70,7 +70,7 @@ This creates two new files, `go.mod` for the module definitions and `go.sum` whi
Next declare the Docsy theme module as a dependency for your site.

```bash
hugo mod get github.com/google/docsy@v0.4.0
hugo mod get github.com/google/docsy@v{{% param "version" %}}
```

This command adds the `docsy` theme module to your definition file `go.mod`.
Expand Down Expand Up @@ -181,10 +181,10 @@ To make sure that your configuration settings are correct, run the command `hugo
```bash
hugo mod graph
hugo: collected modules in 1092 ms
github.com/me/my-existing-site github.com/google/docsy@v0.4.0
github.com/me/my-existing-site github.com/google/docsy/dependencies@v0.4.0
github.com/google/docsy/dependencies@v0.4.0 github.com/twbs/[email protected]+incompatible
github.com/google/docsy/dependencies@v0.4.0 github.com/FortAwesome/[email protected]
github.com/me/my-existing-site github.com/google/docsy@v{{% param "version" %}}
github.com/me/my-existing-site github.com/google/docsy/dependencies@v{{% param "version" %}}
github.com/google/docsy/dependencies@v{{% param "version" %}} github.com/twbs/[email protected]+incompatible
github.com/google/docsy/dependencies@v{{% param "version" %}} github.com/FortAwesome/[email protected]
```

Make sure that three lines with dependencies `docsy`, `bootstrap` and `Font-Awesome` are listed. If not, please double check your config settings.
Expand Down
21 changes: 11 additions & 10 deletions userguide/content/en/docs/Updating/Updating-hugo-module.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: "Update the Docsy Hugo Module"
linkTitle: "Update the Docsy Hugo Module"
title: Update your Docsy Hugo Module
weight: 1
description: >
Update the Docsy theme to the latest version using Hugo Modules.
description: Update your Docsy theme to the latest version using Hugo Modules.
---

When using the Docsy theme as a Hugo Module, updating your theme is really easy.
Expand All @@ -20,20 +18,23 @@ Then invoke hugo's module `get` subcommand with the update flag:
hugo mod get -u github.com/google/docsy
```

Hugo automatically pulls in the latest theme version. That's it, your update is done!

Hugo automatically pulls in the latest theme version. That's it, your update is
done!

{{% alert title="Tip" %}}
If you want to set your module to a certain version inside the docsy theme repo, simply specific the name of the tag representing this version (here: _v0.4.0_) when updating your theme:

If you want to set your module to a certain version inside the Docsy theme repo,
simply specify the name of the tag representing this version when updating your
theme, for example:

```bash
hugo mod get -u github.com/google/docsy@v0.4.0
hugo mod get -u github.com/google/docsy@v{{% param "version" %}}
```

Instead of a version tag, you can also specify a commit hash inside the repo (here: _6c8a3afe_) when updating your theme:

Instead of a version tag, you can also specify a commit hash, for example:

```bash
hugo mod get -u github.com/google/docsy@6c8a3afe
```

{{% /alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ At your command prompt, run the following:
hugo new site my-new-site
cd my-new-site
hugo mod init github.com/me/my-new-site
hugo mod get github.com/google/docsy@v0.4.0
hugo mod get github.com/google/docsy@v{{% param "version" %}}
cat >> config.toml <<EOL
[module]
proxy = "direct"
Expand All @@ -36,7 +36,7 @@ hugo server
hugo new site my-new-site
cd my-new-site
hugo mod init github.com/me/my-new-site
hugo mod get github.com/google/docsy@v0.4.0
hugo mod get github.com/google/docsy@v{{% param "version" %}}
(echo [module]^

proxy = "direct"^
Expand Down Expand Up @@ -83,7 +83,7 @@ This creates two new files, `go.mod` for the module definitions and `go.sum` whi
Next declare the Docsy theme module as a dependency for your site.

```bash
hugo mod get github.com/google/docsy@v0.4.0
hugo mod get github.com/google/docsy@v{{% param "version" %}}
```

This command adds the `docsy` theme module to your definition file `go.mod`.
Expand Down