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

Rename config.yaml to hugo.yaml #1404

Merged
merged 1 commit into from
Feb 11, 2023

Conversation

chalin
Copy link
Collaborator

@chalin chalin commented Feb 11, 2023

@chalin chalin added the CI/infra CI & infrastructure label Feb 11, 2023
@chalin chalin merged commit 25eb2f5 into google:main Feb 11, 2023
@chalin chalin deleted the chalin-im-hugo.yaml-2023-02-11 branch February 11, 2023 13:44
@deining
Copy link
Collaborator

deining commented Feb 11, 2023

Two comments/thoughts on this:

  • with that change in place, we should follow up and rename dependencies/config.toml to dependencies/hugo.toml as well.
  • hugo userdoc states:
We will still look for config.toml etc., but we recommend you eventually rename it
(but you need to wait if you want to support older Hugo versions)

In the current form of the repo, e.g. userguide runs with latest hugo version 0.110.0 only. Shouldn't we add a copy of hugo.toml as config.toml, thus making this a backwards compatible change?

@chalin: WDYT?

@chalin
Copy link
Collaborator Author

chalin commented Feb 12, 2023

Ah, right. Officially Docsy only supports the latest version of Hugo, but I'm certainly willing to bring this up during Monday's PSC meeting. Thanks for the feedback! (I've added this thread to the meeting notes.)

@chalin
Copy link
Collaborator Author

chalin commented Feb 13, 2023

Also, I think that folks using an older version of Hugo will be able to use Hugo's --config flag to get around this (i.e., to pick up Docsy's hugo.* config).

Can you test this @deining?

@deining
Copy link
Collaborator

deining commented Feb 13, 2023

Also, I think that folks using an older version of Hugo will be able to use Hugo's --config flag to get around this (i.e., to pick up Docsy's hugo.* config).

Can you test this @deining?

I had this idea, too, and no, I wasn't able to make older version run just by using the --config flag. The only way to serve the userguide with hugo versions <0.110 (with current HEAD of repo) was:

  • copy userguide/hugo.yaml to userguide/config.yaml
  • copy hugo.yaml to config.yaml

For whatever reason, sym-linking these files wasn't suffiient, so I had to copy both files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants