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

Instructions to get started in README #7

Open
rolfkleef opened this issue Jul 1, 2020 · 2 comments
Open

Instructions to get started in README #7

rolfkleef opened this issue Jul 1, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@rolfkleef
Copy link
Contributor

rolfkleef commented Jul 1, 2020

I've added a pull request with two things:

  • Some README instructions to help people get started with this repo.
  • .gitignore for locally generated files (when testing) that shouldn't go into git.

It might be good to make hugo the default branch in the settings of the repository:

  • It will show the source rather than the generated site (and the README on that branch).
  • If someone creates a pull request, I think it will pick the hugo branch by default.

And perhaps as a by the way @cirulls: I had another pull request for the CNAME file, but located in the hugo branch under static. I just closed that, but now am thinking that when the Github Action regenerates the static site, your commit of that file on the master branch will be overwritten. So perhaps we need that file on the hugo branch after all.

@cirulls
Copy link
Member

cirulls commented Jul 2, 2020

Yes, the CNAME file must be committed to the Hugo branch as well, thanks for creating the PR, I'll review it in the next days but it looks fine. It was created automatically in the master branch when I did the custom DNS configuration. I agree that the hugo branch should be the default one as PRs are going to be created against that branch. I'll change these settings by the end of this week.

@cirulls
Copy link
Member

cirulls commented Jul 6, 2020

Just to keep track of work done elsewhere: for README and .gitignore see #5, for CNAME and branche see #4 (comment).

@cirulls cirulls added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants