Skip to content

Commit

Permalink
Update logo link instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sapols authored Jan 18, 2024
1 parent 987250a commit e9a2cd5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion _pages/docs/adding_to_pyhc_project_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In `projects.yml`, projects are listed in alphabetical order. Available inputs f
* The project name (name) *
* The project's website url (url),
* A description of the project's main function (description) *,
* The location of the project's logo (logo)
* A direct link to the raw image of the project's logo (logo)
* The location of the project's documentation (docs)
* The location of the project's code base (code) *
* Who to contact for questions about the project (contact) *
Expand Down Expand Up @@ -71,6 +71,8 @@ yml file. An example project's inputs are shown below.
&nbsp;&nbsp;&nbsp;&nbsp; <code>python3: ["<a href="https://img.shields.io/badge/Good-brightgreen.svg">https://img.shields.io/badge/Good-brightgreen.svg</a>", "Good"]</code><br>
&nbsp;&nbsp;&nbsp;&nbsp; <code>license: ["<a href="https://img.shields.io/badge/Good-brightgreen.svg">https://img.shields.io/badge/Good-brightgreen.svg</a>", "Good"]</code><br>

If your project logo is in GitHub, use a link to the raw image or else it won't render in the "card" view on the PyHC Projects page.

Acceptable keywords are found in the [PyHC Taxonomy](https://github.com/heliophysicsPy/heliophysicsPy.github.io/blob/main/_data/taxonomy.yml). They are organized into seven categories for ease of use. If you feel that your project requires a keyword that is not yet in the taxonomy, you may include an update to `taxonomy.yml` in your PR.

Once you've added your project's information to projects.yml, commit and push your changes. Then, create a new PR
Expand Down

0 comments on commit e9a2cd5

Please sign in to comment.