From a21c0bedd6306d2c060983d59a79cd951e6c3f43 Mon Sep 17 00:00:00 2001 From: Nathan Schneider Date: Thu, 29 Sep 2022 02:17:49 +0000 Subject: [PATCH] Fixed the edit_uri field and updated Contributing instructions --- files/docs/about/contributing.md | 17 +++++++++++++++-- files/mkdocs.yml | 1 + 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/files/docs/about/contributing.md b/files/docs/about/contributing.md index 8dc68e7..9a4a84e 100644 --- a/files/docs/about/contributing.md +++ b/files/docs/about/contributing.md @@ -26,10 +26,23 @@ Each entry should have the following sections: Crypto Wake is hosted on a repository in GitLab, and entries are written in a simple format called [Markdown](https://www.markdownguide.org/cheat-sheet). To contribute, use the following steps: -* Press "Contribute" on the top-right of the website, or go [here](https://cryptowake.medlab.host/) +To edit an existing Story: + +* Press the pencil icon in the top-right of the Story's page to visit its source page on GitLab. +* Log into GitLab. You can use various social logins, from Google to GitHub. +* Press "Open in Web IDE." +* Proceed with "Make and save your changes" below. + +To create a new Story: + +* Press "Contribute" on the top-right of the website, or go [here](https://gitlab.com/medlabboulder/crypto-wake/) * Log into GitLab. You can use various social logins, from Google to GitHub. * Then press "Web IDE" on the main repository page. When prompted, press "Fork project." This will create a copy of the project on your account. -* On the left file listing, navigate to `files > docs > stories` to see a list of existing story pages. Choose a story page to edit or create a new one using the pop-up menu next to the `stories` folder. +* On the left file listing, navigate to `files > docs > stories` to see a list of existing story pages. Create a new one using the pop-up menu next to the `stories` folder. Follow the naming convention of the other Stories. +* Proceed with "Make and save your changes" below. + +Make and save your changes: + * Make the changes you would like to see, in one file or multiple files. * When you're finished, press the "Create commit..." button under the file listing on the left. * Enter some text as a commit message that summarizes what you did. diff --git a/files/mkdocs.yml b/files/mkdocs.yml index c048cf9..8f9e129 100644 --- a/files/mkdocs.yml +++ b/files/mkdocs.yml @@ -4,6 +4,7 @@ site_url: 'https://cryptowake.medlab.host' copyright: 'A project of the Media Enterprise Design Lab at CU Boulder
License: Creative Commmons Attribution 4.0 International (CC BY 4.0)' repo_name: 'Contribute' repo_url: 'https://gitlab.com/medlabboulder/crypto-wake' +edit_uri: '-/blob/master/files/docs/' extra_css: - 'stylesheets/extra.css' theme: