Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting this family member in the new compendium #27

Open
jh-RLI opened this issue Jan 19, 2024 · 2 comments
Open

Documenting this family member in the new compendium #27

jh-RLI opened this issue Jan 19, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@jh-RLI
Copy link

jh-RLI commented Jan 19, 2024

It would be great if someone could document oepn-dapro in our compendium. This will help to keep an overview of all our tools, and by providing a short description, users can better understand what this tool does in the context of the OE family.

The compendium is a simple mkdocs page hosted by github pages. It is maintained in this repo. : https://github.com/OpenEnergyPlatform/organisation
Content can be added by simply writing Markdown.
We use https://squidfunk.github.io/mkdocs-material/

I assume this tool could be documented on this site? What do you think?

https://github.com/OpenEnergyPlatform/organisation/blob/production/compendium/family_members/open-process-integration.md

The rendered website looks like this:
https://openenergyplatform.github.io/organisation/family_members/open-process-integration/

If you don't want to go to the trouble of adding content to the compendium, it would be nice if you could provide the descriptive text in this issue so I can add it later.

@jh-RLI jh-RLI added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 19, 2024
@FlorianK13
Copy link
Member

Hi @jh-RLI - I just saw this Issue. Yes, it is probably good to document open-dapro in the collection of OE family tools. Maybe the content of the documentation page from open-dapro could be of use? https://openenergyplatform.github.io/open-dapro/

@jh-RLI
Copy link
Author

jh-RLI commented Jan 24, 2024

Good idea, I will add a short text from the docs. It would be great if you could check if this is ok. I'll let you know once I've added it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants