website: Add instructions for dev environment #32
Conversation
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
4332412 to
8571fe3
Compare
Contributes FOSSRIT/fossrit.github.io#86, but does not close it. This commit migrates the existing content from the `CONTRIBUTING.md` into the Runbook, so there is only one place to refer to for important information about the website. Subsequent PRs will update the fossrit.github.io repo to point to the Runbook once this commit is built in the production docs site. Note these docs cover a a modified workflow for the development environment. This change is introduced in FOSSRIT/fossrit.github.io#88. Closes FOSSRIT/fossrit.github.io#80. ^^I am closing that issue with this commit because it asks for a non-trivial amount of documentation about how to set up the Jekyll stack from scratch. This is something that varies on different developer workstations and operating systems. If someone sets something up one way, it may not be reproducible to how the production site is built. Since we are using fully Free Software container tools to build the development environment, I prefer to choose one and only one way to standardize our development environment. If someone wishes to do it another way, then that is their own prerogative. Signed-off-by: Justin W. Flory <git@jwf.io>
8571fe3 to
00eaf5f
Compare
Comment on lines
+92
to
+96
| To build the site and serve it as a website from your workstation, run the following script: | ||
| ```sh | ||
| ./build.sh | ||
| ``` |
Member
There was a problem hiding this comment.
I am a bit confused here. I can't find build.sh in fossrit.github.io
Would you mind adding the location of the script to run in order to build and serve Jekyll locally?
Member
There was a problem hiding this comment.
Got it. I see build has not yet been push because of PR #88 (FOSSRIT/fossrit.github.io#88).
kevinassogba
approved these changes
Feb 20, 2020
Member
Author
|
Awesome, thanks for digging into this one @10eMyrT! Going to merge this one too. 🎬 |
justwheel
added a commit
to FOSSRIT/fossrit.github.io
that referenced
this pull request
Feb 20, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and FOSSRIT/runbook#32. Now that contributing guidelines and advice about maintaining this site lives in the Runbook, the duplicated info is removed from this repo. Instead, the reader is redirected to the Runbook. Stay D.R.Y. - Don't Repeat Yourself! Closes #86. Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel
added a commit
to FOSSRIT/fossrit.github.io
that referenced
this pull request
Feb 20, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and FOSSRIT/runbook#32. Now that contributing guidelines and advice about maintaining this site lives in the Runbook, the duplicated info is removed from this repo. Instead, the reader is redirected to the Runbook. Stay D.R.Y. - Don't Repeat Yourself! Closes #86. Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel
added a commit
to FOSSRIT/fossrit.github.io
that referenced
this pull request
Feb 20, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and FOSSRIT/runbook#32. Now that contributing guidelines and advice about maintaining this site lives in the Runbook, the duplicated info is removed from this repo. Instead, the reader is redirected to the Runbook. Stay D.R.Y. - Don't Repeat Yourself! Closes #86. Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel
added a commit
to FOSSRIT/fossrit.github.io
that referenced
this pull request
Feb 25, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and FOSSRIT/runbook#32. Now that contributing guidelines and advice about maintaining this site lives in the Runbook, the duplicated info is removed from this repo. Instead, the reader is redirected to the Runbook. Stay D.R.Y. - Don't Repeat Yourself! Closes #86. Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel
added a commit
to FOSSRIT/fossrit.github.io
that referenced
this pull request
Feb 25, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and FOSSRIT/runbook#32. Now that contributing guidelines and advice about maintaining this site lives in the Runbook, the duplicated info is removed from this repo. Instead, the reader is redirected to the Runbook. Stay D.R.Y. - Don't Repeat Yourself! Closes #86. Signed-off-by: Justin W. Flory <git@jwf.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributes FOSSRIT/fossrit.github.io#86, but does not close it.
This commit migrates the existing content from the
CONTRIBUTING.mdinto the Runbook, so there is only one place to refer to for important
information about the website. Subsequent PRs will update the
fossrit.github.io repo to point to the Runbook once this commit is built
in the production docs site.
Note these docs cover a a modified workflow for the development
environment. This change is introduced in FOSSRIT/fossrit.github.io#88.
Closes FOSSRIT/fossrit.github.io#80.
^^I am closing that issue with this commit because it asks for a
non-trivial amount of documentation about how to set up the Jekyll stack
from scratch. This is something that varies on different developer
workstations and operating systems. If someone sets something up one
way, it may not be reproducible to how the production site is built.
Since we are using fully Free Software container tools to build the
development environment, I prefer to choose one and only one way to
standardize our development environment. If someone wishes to do it
another way, then that is their own prerogative.