Contributing content

This page provides a step-by-step tutorial for contributing content to metacademy.org. Eventually, we will make this process easier, e.g. you will be able to contribute content directly through metacademy.org.

1. Fork this repository and clone it to your computer git clone https://github.com/your-id/metacademy-content.git, replace your-id with your Github id.

2. In order to test your contributions locally, you must also clone/install the application server; you can find the instructions for doing this at: https://github.com/metacademy/metacademy-application, (see README.md)

3. The content editing guidelines wiki describes the central guidelines that we try to follow when contributing content; these are just rules-of-thumb, though, and they may not make sense for the content you're contributing. It's a good idea to skim this documentation now and consult it when you have specific questions. (if this documentation does not discuss a particular question you have, or if you'd like to discuss various changes/additions/etc to the documentation, please email [email protected])

4. The [database format wiki](Database format) describes the structure of each concept directory. If you would like to edit a preexisting concept, simply make changes to the appropriate file (consult the [database format wiki](Database format) if you are unsure what files you should change in order to have the desired effect) and then submit a pull request (see below). If you would like to create a new concept, copy /concepts/ANNOTATED_EXAMPLE to /concepts/concept_tag where concept_tag is the URL tag used to navigate to the given concept, e.g. http://www.metacademy.org/concepts/concept_tag. Fill out the files with the data for your concept (again, consult [the database format wiki](Database format) for further specification of these files)

5. run python assign_ids.py from the base directory

6. Verify that contributions display correctly: follow the instructions given in README.md of https://github.com/metacademy/metacademy-application to run the test server, and then navigate to e.g. http://localhost:8080/concepts/changed_concept_tag where changed_concept_tag is the name of the content directory that contains the changed/new content.

7. submit a pull request to metacademy-content, see creating a pull request for details on how to do this.