Skip to content

README should specify *extended* Hugo #231

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

Closed
bjnath opened this issue May 17, 2020 · 10 comments
Closed

README should specify *extended* Hugo #231

bjnath opened this issue May 17, 2020 · 10 comments

Comments

@bjnath
Copy link
Contributor

bjnath commented May 17, 2020

A user who installs Hugo by following the Getting Started link in the README will get the failure

error: failed to transform resource: TOCSS: failed to transform "style.sass"

when they run hugo server.

Users need to install the extended version, e.g.,

sudo apt-get install ./hugo_extended_0.70.0_Linux-64bit.deb

which I don't think is mentioned in the page we're linking to.

Extended Hugo is a requirement of the Hugo Fresh theme (see Troubleshooting at the bottom the page).

@rgommers
Copy link
Member

That's right, good catch. You're not the first one to run into that @bjnath. Would you be able to open a PR to fix the README?

@bjnath
Copy link
Contributor Author

bjnath commented May 17, 2020

Wasn't able to push the PR:

(doc-build-38) bjn@lynnfield:~/numpy_newsite/numpy.org$ git push origin hugo_install_readme
ERROR: Permission to numpy/numpy.org.git denied to bjnath.

@rgommers
Copy link
Member

That's because the standard workflow is for you to "fork" this repo (button at right top of the page). You then push your changes to a new branch in your own fork, and from there you can send a PR.

The process is described at https://numpy.org/devdocs/dev/index.html#development-process-summary (just change the name of the repo from numpy to numpy.org).

@rgommers
Copy link
Member

The rationale for that is that is we let every contributor create new branches in this repo, it would get very messy very quickly. Pretty much every open source project uses this "send PR from forks" method.

@bjnath
Copy link
Contributor Author

bjnath commented May 19, 2020

I did fork:
image

and the step that failed was right out of https://numpy.org/devdocs/dev/index.html#development-process-summary:

image

@bjnath
Copy link
Contributor Author

bjnath commented May 19, 2020

OK, I see -- I have origin set the same as upstream:

(doc-build-38) bjn@lynnfield:~/numpy_newsite/numpy.org$ git remote -v
origin  [email protected]:numpy/numpy.org.git (fetch)
origin  [email protected]:numpy/numpy.org.git (push)
upstream        https://github.com/numpy/numpy.org.git (fetch)
upstream        https://github.com/numpy/numpy.org.git (push)

I'll fix it and try again.

bjnath added a commit to bjnath/numpy.org that referenced this issue May 19, 2020
Instructs user to install the extended version of Hugo; points to the
Hugo install page and the release page; shows the error message
you'll get from the standard version.
@bjnath
Copy link
Contributor Author

bjnath commented May 19, 2020

All set, filed PR #241

@bjnath
Copy link
Contributor Author

bjnath commented May 19, 2020

PS, @rgommers, thanks for clarifying how it works. I was following the steps but couldn't visualize what was happening.

rgommers added a commit that referenced this issue May 19, 2020
DOC: Fix Hugo install instructions in README (issue #231)
@rgommers
Copy link
Member

No worries, thanks for the PR!

One more tip: if you add in your commit message next time closes gh-231 or fixes gh-231, then this issue gets auto-closed when your PR is merged.

@bjnath
Copy link
Contributor Author

bjnath commented May 19, 2020

Great tip, will do! Thanks.

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

No branches or pull requests

2 participants