FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(readme): and gemlock plus instruction to setup by mgan59 · Pull Request #44 · thegooddocsproject/thegooddocsproject.github.io · GitHub

This repository was archived by the owner on Apr 22, 2021. It is now read-only.
/ thegooddocsproject.github.io Public archive

docs(readme): and gemlock plus instruction to setup - #44

Open
mgan59 wants to merge 1 commit into
masterfrom
add-setup-contributor-guide-to-readme
ConversationCommits (1)ChecksFiles changed
Open

docs(readme): and gemlock plus instruction to setup#44
mgan59 wants to merge 1 commit into
masterfrom
add-setup-contributor-guide-to-readme

Conversation

mgan59 commented Aug 28, 2020

Copy link
Copy Markdown
Contributor

Context

After having to lookup setup instruction twice decided it was time to document them into a readme for the time being till we replace the current site with a Hugo/Docsy version. So to issue #33 I decided to put the basic notes into a readme.

As we get the Hugo project going we should link the readme to the on-going new site work so that others can join and participate as well.

NOTE: we should wait to merge this till after we get #43 merged.

mgan59 added the documentation Improvements or additions to documentation label Aug 28, 2020
jaredmorgs approved these changes Oct 25, 2020
View reviewed changes

jaredmorgs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I can verify these are generic bundle instructions for building a gem-based static site. Thanks for taking the time to document them @mgan59

If you believe there is value in documenting the bundle and ruby version in the project, you can choose to leave them in the README.
Or to save maintenance, you can instruct folks to review the files before they begin developing the project locally, thereby removing the need to keep the README and build files in sync.

mgan59 force-pushed the add-setup-contributor-guide-to-readme branch from 171e5e2 to e8dee3e Compare November 18, 2020 22:49

bwklein commented Mar 27, 2021

Copy link
Copy Markdown
Member

Not relevant to the new Hugo site.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
jaredmorgs jaredmorgs approved these changes
Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL