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

Hugo docs #6

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Hugo docs #6

wants to merge 5 commits into from

Conversation

bachittle
Copy link
Collaborator

Did you read the rules to contributing in CONTRIBUTING.md

I moved contributing.md to the docs. We can decide whether to keep it there or move it back to root

What are you trying to accomplish?

Trying to make a documentation system that can be viewed as a static site (via hugo)

How are you accomplishing it?

in the docs folder is the root to a hugo project. Inside content/ is where all the markdown files are located.

Is there anything reviewers should know?

currently the site is not being hosted, we should discuss what site to host it on (can be as simple as github pages or netlify, since site is static)

If needed, did you change documentation(README.md, ARCHITECTURE.md, etc) to reflect your changes?

I moved documentation, should probably change any references in these documents to each other.

  • Is it safe to rollback this change if anything goes wrong?

@prairir
Copy link
Owner

prairir commented Jan 26, 2022

Instead of moving the md files out, can we leave them where they are and use symbolinks to make hugo think they are where it wants it to be

@bachittle
Copy link
Collaborator Author

oh yea that's a good idea, let me do that.
Linux for the win :)

@bachittle
Copy link
Collaborator Author

I think it's done now, lmk if I did it right

@prairir
Copy link
Owner

prairir commented Jan 26, 2022

does it compile correctly with the symbolinks?

@bachittle
Copy link
Collaborator Author

yea it does, I tested it.

@prairir
Copy link
Owner

prairir commented Jan 27, 2022

LGTM 🚀

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

Successfully merging this pull request may close these issues.

3 participants