Contribute
This guide walks curators and editors through how to update the wiki and add profilies.
NoteIf you want to propose an organization for inclusion please just open an issue in the issue tracker with its details. TODO: more detailed instructions.
Table of Contents
Edit or add to the site via Github
We have given the site a wiki-like structure, meaning people can contribute and add items directly.
Alternatively, if you would like to contribute by a more non-technical method, see below.
How does the site work?
All the content for this site is contained within the Github repo: https://github.com/life-itself/ecosystem
For details TODO: link to relevant section of design.
How to edit and add to the site
There are two methods for making edits to the website:
- Edit directly in Github
- Edit on your local machine (using a code editor or Obsidian)
Edit in Github
TODO: most of this should be on "usemarkdown.org" or whatever we call it âŚ
We just want any special points for this project.
Setup
- Create a GitHub account if you donât already have one
Key steps
- Go to the repo storing the website content: https://github.com/life-itself/ecosystem
- All edits can be made in the main repo - unlike adding content to the site (see below), you can make edits to existing pages without forking the repo.
- Look for the file that corresponds with the page you want to edit. To find the file, it might help to look at the page URL. E.g. To find the file containing the profile page for 42 Acres (https://ecosystem.lifeitself.us/profiles/alter-ego), go to the folder âcontentâ, then âprofilesâ, then the file âalter-ego.mdâ.
- Click on the pencil icon in the upper right corner to edit this file
- Make your edits
- Once youâve made your edits, go to the bottom of the page where you will see a box titled âPropose changesâ. Type into the first text box below âPropose changesâ a brief description of the edits you have made. E.g. âfix typoâ, âadd citationâ or âexpand definitionâ. Use the box below that for optional further description of your edits.
- Then click the button that says âPropose changesâ.
- Once youâve clicked the âPropose changesâ button you will be taken to a new page. Here, click the button that says âCreate pull requestâ. This will notify a team member to review and confirm the edits youâve made.
- Once theyâve done that, your edit will appear on the site! Thanks for contributing!
Add to the website in Github
- Go to the repo storing the website content: https://github.com/life-itself/ecosystem
- Unlike when you are editing an existing page, in order to add a page to the site, you are going to fork the Life Itself ecosystem repo. To do this, click the âForkâ button at the top right of the page.
- Click the green âCreate forkâ button
- You have now created a fork! You can see that you are working in a fork of the repo by looking at the top left of the screen. It should look like this (but with your own user name).
- We now recommend that you do all the following steps in the same pull request. That way, you can request all the additions to the site you want to make in one request. But weâre getting ahead of ourselves, letâs add some content!
Templates
To add a new profile page, please use the profiles-template.md in the ecosystem repo.
Copy the raw contents from the relevant template by clicking the icon with 2 squares overlapping.
Adding a page
Create the page
- In your fork of the ecosystem repo, go to the folder âcontentâ, then select the folder representing the type of page you want to add, eg âprofilesâ or âtopicsâ.
- Click on the âAdd fileâ button in the upper right corner to add a new page. Select, âcreate new fileâ.
- On the top right, under the âCancel changesâ button is the line wrap mode box. Select âSoft wrapâ.
Add the frontmatter
- Place your cursor in line with the figure â1â. Then âright clickâ (two finger click on a mac) and select paste. Alternatively, select command+v to paste. This will paste in your template (ensure the template was the last thing you copied).
- Fill in the frontmatter with the relevant information. The template that you have copied across will contain information from another organization/topic. We have left this information in place so you can see how the information should be inputted.
- For a new profile page, the following answers can be left as is, the rest should be tailored to your oragnization.
- Notes_data_entry
- Curation_status
- To add a logo and image to your profile:
- Save the logo and photo you want to be featured on the profile to your computer. Name these files on your computer something that represents the images (eg organization-name-logo.png and organization-name-image.png).
- Copy the name of one of the files you have just made.
- Paste the name of the file into the relevant field in the frontmatter for the profile eg logo, cached. Add /img/ to the beginning so it should look like this: logo: cached: /img/organization-name-logo.png
- Do the same steps for the other image.
- In the url sections of the frontmatter for the logo and image, paste the url of where you downloaded the logo and image from (eg https://www.facebook.com/AlterEgoNetwork/photos/a.163253037723176/163253617723118/).
- The image and logo fields of the frontmatter should look like this:
- For a new topics page, leave âimageâ as is. Fill in the rest of the information as appropriate for the topic you are creating the page for. Have fun picking an emoji that you think best represents it!
- Note: All fields within the frontmatter are optional. Remove (or leave empty) the fields that are not in use to eliminate any errors during build.
- Name your file. In the box that says âname your fileâ, paste in the âidâ of your page followed by â.mdâ. Eg for a profile, it should look like this:
Adding a description
- Once you have filled in the frontmatter, add a brief description of the topic/organization. Use the example description to guide what your description should contain and how it should be formatted.
Check and propose changes
- Once you have filled in the frontmatter and have added a description, check itâs all worked. Click the preview button. It should look like this for a profile:
- Or this for a topic:
- Once youâve checked everything looks fine, and youâre ready to commit the new file, go to the bottom of the page where you will see a box titled âCommit new fileâ. Type into the first text box below a brief description of what you are proposing, eg âadd alter-ego.mdâ. Use the box below that for optional further description of your edits.
- Now you are going to commit directly to the main branch by clicking the green button that says âCommit new fileâ.
- Well done! But youâre not done yet. Remember the logo and image you downloaded to your computer? Now you need to upload them to the repo.
Adding an image/logo
- Remaining in your fork of the ecosystem repo, click âcontentâ, then âassetsâ, then "img". Once here, click on the âAdd fileâ button, then select âUpload filesâ. Once here, click on the âAdd fileâ button, then select âUpload filesâ. Upload your two files eg organization-name-logo.png and organization-name-image.png
- Once youâve uploaded the images, go to the bottom of the page where you will see a box titled âCommit changesâ. Type into the first text box below a brief description of what you are proposing, eg âadding imagesâ.
- Now you are going to commit these images directly to the main branch by clicking the green button that says âCommit changesâ.
Open pull request
- Now that youâve committed your new page and the relevant images, youâre ready to open the pull request. Head back to your fork of the ecosystem repo. You should see a box that looks like this:
- Click the âContribute buttonâ. Now click the green âOpen pull request buttonâ
- In the box that says âTitleâ, give a title to your pull request. Something like âAdd (name of organization) profile page + imagesâ.
- Now click the green âCreate pull request buttonâ. This will notify a team member to review and confirm the additions youâve made to the site.
- Once theyâve done that, your edit will appear on the site! Thanks for contributing!
Glossary
- Repo => short for Repository. Contains all a projectâs files.
- Working directory => The folder you are currently working in.
Contact
If you have any issues while following this guide, please let us know so we can improve this guide to help future contributors.