The website served at https://social-science-data-editors.github.io/ is built by quarto on github actions. Contributing and developing locally is encouraged via issues and pull requests. Here is an outline of how to run the site locally in order to test out changes before making any suggestions.
We use quarto as a website builder. You need to install this for your system here. You can then develop the website in a series of tools (RStudio, VSCode, etc).
By default quarto will render any file ending in .qmd (quarto markdown). This just another markdown dialect, and you can find a simple example of how to get started here. The content of the website is in the docs directory. To see the result of your edits, you can execute on the command line
quarto render my_file.qmd
which would create some output (depending on the frontmatter you set in your .qmd file - by default, an .html file). Alternatively, and quite conveniently, IDEs like RStudio or VScode will allow you to render and watch a quarto project, so your changes will be reflected immediately in the built-in browser (or in your default browser at localhost). The VSCode Quarto Extension is needed for this to work in VScode.
Here is a cookbook recipe:
- Create an issue with your concern by clicking here and discuss with the maintainers about your proposal [Optional]
- Create your fork on github.com by clicking here
- Clone your fork to your computer
- Create a new local branch, ideally with a name that relates to your issue
- Make your edits to the source of the website
- Build the website locally to check your edits had the desired effect
- Make a commit: notice that we specified git to ignore the built site in
_site- do not override this setting please. - Push to your fork and create the pull request against this repository.
- Thanks for your contribution!