Skip to content

Commit

Permalink
Merge pull request #1907 from OpenEnergyPlatform/enhance-docs
Browse files Browse the repository at this point in the history
Enhance docs
  • Loading branch information
jh-RLI authored Nov 17, 2024
2 parents 8f42332 + 813d7f4 commit e80deab
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ title: Home
Welcome to the Open Energy Platform Documentation. This site provides the developer documentation for the Open Energy Platform (OEP).

!!! Info "State of the documentation"
The documentation already provides helpful information but is not yet complete. As only parts of it were maintained during the long-term development, we have to catch up. This is a task that we cannot complete in one go. We have therefore decided to complete it step by step. This means that we will update the documentation of the missing code as soon as we have to work on the corresponding code again. Documentation for the Community area will be added continuously and in a timely manner.
The documentation already provides helpful information but is not yet complete. As only parts of it were maintained during the long-term development, we have to catch up. This is a task that we cannot complete in one go. We have therefore decided to complete it step by step. This means that we will update the documentation of the missing code as soon as we have to work on the corresponding code again. Documentation for the Community area will be added continuously and in a timely manner.

!!! Info "Compendium"
If you want to get an overview about the complete Open Energy Family Framework please have a look at our [Compendium](https://openenergyplatform.github.io/organisation/).
If you want to get an overview about the complete Open Energy Family Framework please have a look at our [Compendium](https://openenergyplatform.github.io/organisation/).

## Structure of the documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/guides/manual-db-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,6 @@ dbname = os.environ.get("LOCAL_DB_NAME", "oedb")

## 4 Create the database tables

To complete the database installation, the table structures must then be installed. [Step 3](./installation.md#3-setup-the-openenergyontology-integation) & [Step 4](./installation.md#4-loading-and-compressing-static-assets-from-the-oeplattform-applications) must be completed first so that the necessary commands can be executed after.
To complete the database installation, the table structures must then be installed. [Step 3](./installation.md#3-setup-the-openenergyontology-integration) & [Step 4](./installation.md#4-loading-and-compressing-static-assets-from-the-oeplattform-applications) must be completed first so that the necessary commands can be executed after.

After that Proceed with the next steps in section [4.2 Create the database table structures](installation.md#32-create-the-database-table-structures) of the oeplatform installation guide.
2 changes: 1 addition & 1 deletion oeplatform/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
"tutorials_wizard": "https://openenergyplatform.github.io/academy/tutorials/99_other/wizard/", # noqa E501
"tutorials_create_database_conform_data": "https://openenergyplatform.github.io/academy/tutorials/99_other/database_data/", # noqa E501
"tutorials_oemetadata": "https://openenergyplatform.github.io/academy/tutorials/99_other/getting_started_with_OEMetadata/", # noqa E501
"readthedocs": "https://oeplatform.readthedocs.io/en/latest/?badge=latest",
"readthedocs": "https://openenergyplatform.github.io/oeplatform/oeplatform-code/web-api/oedb-rest-api/",
"mkdocs": "https://openenergyplatform.github.io/oeplatform/",
"compendium": "https://openenergyplatform.github.io/organisation/",
"tib_terminology_service": "https://terminology.tib.eu/ts/collections",
Expand Down
1 change: 1 addition & 0 deletions versions/changelogs/current.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@

- Added documentation for Design System and Accessibility [(#1716)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1716)
- Restructure documentation layout & enhance content [(#1905)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1905)
- Fix link to rest-api documentation on mkdocs and update text formatting on the documentation main page. [(#1907)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1907)

0 comments on commit e80deab

Please sign in to comment.