Skip to content

Commit

Permalink
Updated references to the old repo name 'dea-docs' to the new name (#…
Browse files Browse the repository at this point in the history
…1204)

* Updated references to the old repo name 'dea-docs' to the new name

* Updated the Known Issues link

---------

Co-authored-by: Benjamin Glitsos <bengyup@gmail.com>
  • Loading branch information
benji-glitsos-ga and Benjamin Glitsos authored Mar 12, 2024
1 parent 77a954a commit 268e99d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/trigger_docs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

name: Trigger DEA Docs Build
# Documentation in this repo is not built in this GitHub Action. Instead, it is built by a separate Action in the dea-docs repo.
# See here: https://github.com/GeoscienceAustralia/dea-docs/blob/master/.github/workflows/main.yml
# Documentation in this repo is not built in this GitHub Action. Instead, it is built by a separate Action in the dea-knowledge-hub repo.
# See here: https://github.com/GeoscienceAustralia/dea-knowledge-hub/blob/main/.github/workflows/deploy-production.yaml

# The below action triggers a build in dea-docs when changes are pushed to the 'stable' branch in the current repo
# The below action triggers a build in dea-knowledge-hub when changes are pushed to the 'stable' branch in the current repo

on:
push:
Expand All @@ -18,6 +18,6 @@ jobs:
uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.REPO_PAT }}
repository: GeoscienceAustralia/dea-docs
repository: GeoscienceAustralia/dea-knowledge-hub
event-type: republish-docs

2 changes: 1 addition & 1 deletion DEA_notebooks_template.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"* When adding **Products used**, embed the hyperlink to that specific product on the DEA Explorer using the `[product_name](product url)` syntax.\n",
"* When writing in Markdown cells, start each sentence on a **new line**. This makes it easy to see changes through git commits.\n",
"* Use Australian English in markdown cells and code comments.\n",
"* Check the [known issues](https://github.com/GeoscienceAustralia/dea-docs/wiki/Known-issues) for formatting regarding the conversion of notebooks to DEA docs using Sphinx. Things to be aware of:\n",
"* See the [Knowledge Hub formatting troubleshooting guide](https://github.com/GeoscienceAustralia/dea-notebooks/wiki/Troubleshooting-Knowledge-Hub-formatting) to ensure your formatting will display properly on the [DEA Knowledge Hub](https://knowledge.dea.ga.gov.au/). Things to be aware of:\n",
" * Sphinx is highly sensitive to bulleted lists:\n",
" * Ensure that there is an empty line between any preceding text and the list\n",
" * Only use the `*` bullet (`-` is not recognised)\n",
Expand Down

0 comments on commit 268e99d

Please sign in to comment.