Skip to content

Commit

Permalink
docs: remove duplicated common changes from the README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbottigliero committed Mar 27, 2024
1 parent 2ec7d7b commit a072dab
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,16 @@ While this repository is a working example of a data portal, it is also a templa
1. Update the `static.json` to include:
* `data.attributes.globus.application.client_id` – The UUID of the client created in **the previous step**.
* `data.attributes.globus.transfer.collection_id` – The Collection UUID that will be the "source" of your data portal.
* Optional: Set the `data.attributes.globus.transfer.path` to a specific path within the collection.
* See the [static.json](#staticjson) type definitions for more configuration options.
1. **That's it!** The changes made (and any future changes) to the `static.json` will trigger a GitHub Action that will automatically build and deploy your research data portal to your GitHub Pages URL.


#### Common Changes after Creating Your Portal

- **Updating the Title and Tagline** – Update the `data.attributes.content.title` and `data.attributes.content.tagline` in the `static.json`.
- **Updating the Privacy Policy and Terms of Service** – Update the `data.attributes.content.privacy_policy` and `data.attributes.content.terms_of_service` in the `static.json`.
- **Changing the Collection Path** – Update the `data.attributes.globus.transfer.path` in the `static.json`.
- **Removing this section of the README** – Remove this section from the `README.md` file.
- **Edit/Remove the `CITATION` file** – Update the `CITATION` file to reflect the appropriate citation information for your research data portal – [learn more about `CITATION` files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files).

- **Removing this section of the README** – Remove this section from the `README.md` file or update the README to meet your needs.

----

Expand Down

0 comments on commit a072dab

Please sign in to comment.