Contributing to the site, no matter how small a contribution, is incredibly valuable to the Rainbow Six community. Whether your contribution is fixing a typo or a strategy guide, it will provide players a better overall experience within the community with the end result of a strong and long lasting community. The stronger the community, the more resources Ubisoft will invest in improving or adding content to the game. Not to mention, you get added to the list of contributors of the site.
Contributing to the site is also easy to do. The site does not have a database and there are no logins, the only requirement is that you need to create a GitHub account. For those unaware, GitHub is the largest source code hosting provider and has been a key player in the explosion of open-source software development powering nearly every website and application in the world.
Instructions to contribute
TL;DR
- Fork the site repo.
- Add or change content
- Commit the changes to your fork
- Submit a pull request to merge your changes with the sites code
- Play more Rainbow Six Siege
Forking repo
- Navigate to the Rainbow Six Bootcamp website repository on GitHub. Create an account if necessary.
- Fork the code for the site. If your first thought is “what the fork”, check out GitHub’s guide to forking a repo.
Once you have forked the sites repo once, you don’t have to do this again. You merely need to sync your fork with the latest changes from the sites repository.
Adding / changing content
There are two methods to add or change content. Which method you choose should be determined based on the magnitude of the change. If you are attempting to make a very minor change, for instance fix the spelling or grammar of content, then changing the file directly in your GitHub fork is reasonable. If you are adding a new page of content or modifying a template file, then you should go the route of cloning the site to your computer and modifying the code so you can test your changes.
To understand the structure of the site, the syntax of the pages variables (the text between the +++ symbols) or the syntax of markdown, visit Hugo’s Getting Started page.
Change on GitHub
- Navigate to the fork you created above in Step 1: Forking.
- Navigate to the content file you want to modify.
- Click the pencil icon to Edit the page.
- In the text-area displaying the code, scroll to the content we want to change and make the change.
- Below the text-area enter a comment for your change and click
Commit Changes
Example Say we want to fix a typo on Ash’s operator page in the description.
- In the “<> Code” browser of our fork, we would navigate to
content/advanced-training/operator/fbi-swat/ash.md. - Then click the pencil icon on the right side of the header bar of the preview of Ash’s page.
- In the text-area displaying the code of Ash’s page, scroll to the content we want to change and make the change.
- Below the text-area enter a comment for your change, e.g. “Fix typo in description” and
Commit changes
Change locally
- Clone the repository onto your computer.
- There are several ways to do this but if you are new, I recommend using GitHub’s Desktop app which is easy to use and has great user guides.
- Install Hugo
- If you are adding a new page, please use Hugo’s new content command as it will setup your file properly for the type of content it is. E.g.
hugo new community/clan/clan-name.md -k clan - Open the file you are modifying in a text or code editor. I recommend Atom but any text editor will do.
- Modify the file as needed.
- Test your changes by using Hugo’s builtin web server
hugo server -w - Commit your changes to your local repository and push/sync them back to your fork
Submit pull request
At this point, you have modified the site within your own copy of the sites code. In order to get your changes uploaded to Rainbow Six Bootcamp, you need to submit a GitHub pull request, or PR, to the main site repository. After I receive the PR, I will review your changes and either comment on the PR or approve the changes, merging them into the main source code for the site.
After PR approval
After a PR is approved for merge into the main site source code, I will use Hugo, hugo -b http://rainbowsixbootcamp.com, to build the site and then deploy it to the web server. Your changes are not officially on the site until that is complete.
