GitHub Pages Template repository for 52 For Code Review challenge

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

• 🧰 Usage

• 🗒 Notes

• 📇 Attribution

• ⚖️ Licensing

This repository makes use of Git Submodules to track dependencies, to avoid incomplete downloads clone with the --recurse-submodules option...

git clone --recurse-submodules [email protected]:52ForPeerReview/gh-pages-template.git

To update tracked Git Submodules issue the following commands...

git pull

git submodule update --init --merge --recursive

To force upgrade of Git Submodules...

git submodule update --init --merge --recursive --remote

Note, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.

This repository makes use of Jekyll for building website files from MarkDown and other source files. GitHub Pages automatically builds these files, however, for local/private tests/builds it may be easier to utilize the Jekyll Admin project.

To setup your own blog within the 52ForPeerReview sub-domain, please review the posts found on the Home Page for this Organization.

If you have made a Fork of the gh-pages-template repository then please modify this file and the _config.yml file, first via the after-fork.sh script, eg...

Syntax Example

./after-fork.sh 'account-name'

Usage Example

./after-fork.sh 'S0AndS0'

If you are utilizing this repository as a Template, which is recommended, then please also run the re-init-submodules.sh script too...

./re-init-submodules.sh

... then, make any other edits and/or additions via your favorite text editor.

Each week add a new post about a project that you are publishing that week, there is a new-post.sh script that may be used to generate new post files with the correct FrontMatter...

Syntax Example

./new-post.sh '<title>' '<short description>'

Usage Example

./new-post.sh 'Awk Sorted Unique Count' 'A script to sort and count unique lines or columns'

Example Post rounds/_r000/awk-sorted-unique-count.md

---
layout: post
title: "Awk Sorted Unique Count"
description: "A script to sort and count unique lines or columns"
date: 2020-06-15 13:52:36 -0700
# date_updated:  ## Optional, formatted like 'date' above
time_to_live: 1800
---



Published new project, [<repository-name>][repository__source] that does stuff...


{% highlight awk %}
git clone [email protected]:<organization>/<repository>.git
{% endhighlight %}


... describe what this project does, and how to utilize it.


Then describe any bits that:


- you believe could be improved
- you'd like help with
- and/or questions that arose during development
- etc...


[repository__source]: https://github.com/<organization>/<repository>

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

• Fork this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is [email protected]:<NAME>/<REPO>.git...

cd ~/git/hub/52ForPeerReview/gh-pages-template

git remote add fork [email protected]:<NAME>/gh-pages-template.git

• Commit your changes and push to your Fork, eg. to fix an issue...

cd ~/git/hub/52ForPeerReview/gh-pages-template


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in Issue #42
EOF


git push fork master

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork master however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull orgin master

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

• GitHub -- github-utilities/make-readme

GitHub Pages Template repository for 52 For Code Review challenge
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.