Skip to content

Commit d661b81

Browse files
authored
📝 docs: Link out to FOSSRIT Runbook (closes #86) (#89)
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 <[email protected]>
1 parent 7a922ef commit d661b81

File tree

2 files changed

+6
-44
lines changed

2 files changed

+6
-44
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1 @@
1-
How to contribute
2-
=================
3-
4-
Want to develop or contribute to this project?
5-
Contributions and improvements are appreciated and welcome.
6-
This guide explains how to set up a development environment and make a contribution.
7-
8-
9-
## Create a development environment
10-
11-
This project uses a [**Docker**](https://en.wikipedia.org/wiki/Docker_%28software%29) container to create a development environment.
12-
This solution works with Docker on Linux, macOS, and Windows.
13-
We use Docker to run a container to build and serve the website.
14-
Then, when you make changes, they are reflected immediately in your running copy of the site when you press "Save".
15-
16-
### Pre-requisites
17-
18-
Install Docker:
19-
20-
* Linux
21-
* [Fedora](https://developer.fedoraproject.org/tools/docker/docker-installation.html)
22-
* [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
23-
* [macOS](https://docs.docker.com/docker-for-mac/install/)
24-
* [Windows](https://docs.docker.com/toolbox/overview/)
25-
26-
### Run development script
27-
28-
In a new window, run the [`start_devel_env.sh`](https://github.com/FOSSRIT/fossrit.github.io/blob/master/start_devel_env.sh) script.
29-
This script downloads a Jekyll Docker container and builds the website.
30-
Once it starts, you can access a local version of the website by visiting this URL:
31-
32-
```
33-
http://localhost:4000
34-
```
35-
36-
## Submitting contributions
37-
38-
More detailed steps will be documented in the future.
39-
For now, if you want to contribute, submit a new pull request.
1+
See the [_Website (fossrit.github.io)_](https://runbook.fossrit.community/infra/website/ "Website (fossrit.github.io) - FOSSRIT Runbook") page in the [FOSSRIT Runbook](https://runbook.fossrit.community/).

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Official website for Free and Open Source Software @ RIT MAGIC Center and FOSS a
88

99
## About
1010

11-
This is the website for the Free and Open Source Software initiative at the [RIT MAGIC Center](https://magic.rit.edu/ "RIT MAGIC Center - website").
12-
This website covers both institution programs and work as well as the FOSS academic courses.
13-
It is also used to communicate other information of interest to the RIT FOSS community.
11+
This is the website for the Free and Open Source Software initiative at the [RIT MAGIC Center](https://www.rit.edu/magic/ "RIT MAGIC Center - website").
12+
This website includes content for community initiatives, FOSS academic courses, and more.
13+
It is also used to communicate announcements to the RIT FOSS community.
1414

1515

16-
## Contributing
16+
## How to contribute
1717

18-
For help with contributing and making a development environment, see [CONTRIBUTING.md](https://github.com/FOSSRIT/fossrit.github.io/blob/master/.github/CONTRIBUTING.md).
18+
See the [_Website (fossrit.github.io)_](https://runbook.fossrit.community/infra/website/ "Website (fossrit.github.io) - FOSSRIT Runbook") page in the [FOSSRIT Runbook](https://runbook.fossrit.community/).
1919

2020

2121
## Legal

0 commit comments

Comments
 (0)