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

Update docs and contributing files to facilitate access to OEO for new users #1808

Closed
2 of 7 tasks
chrwm opened this issue Jan 25, 2024 · 2 comments · Fixed by #1937 or #1946
Closed
2 of 7 tasks

Update docs and contributing files to facilitate access to OEO for new users #1808

chrwm opened this issue Jan 25, 2024 · 2 comments · Fixed by #1937 or #1946
Assignees
Labels
To do Issues that haven't got discussed yet wiki about adding or editing the wiki

Comments

@chrwm
Copy link
Member

chrwm commented Jan 25, 2024

Description of the issue

So far only instructions for implementations--> wiki/how to implement

  • Revise CONTRIBUTING and explain requirements (Academy course, meetings, interaction with issues) and refer to wiki, but details elsewhere
  • Read and sort wiki, Academy course and contributing again
    • wiki
    • academy course
    • contributing
  • Readme as an introduction, work out the collaboration section and refer to the rest https://contributing.md/how-to-build-contributing-md/

Workflow checklist

  • I am aware of the workflow for this repository
@chrwm chrwm added the To do Issues that haven't got discussed yet label Jan 25, 2024
@chrwm chrwm self-assigned this Jan 25, 2024
@chrwm chrwm added the wiki about adding or editing the wiki label Jan 25, 2024
@l-emele l-emele added this to the Meta milestone milestone Feb 26, 2024
@madbkr
Copy link
Contributor

madbkr commented Oct 2, 2024

So far only instructions for implementations--> wiki/how to implement

I am not sure what the OP wanted here. The wiki has a whole list of different tutorials, none of them named "how to implement". There is however a "how to contribute" which links to CONTRIBUTING.md.
Maybe the issue was already resolved when the wiki got reworked. In any case I don't see what else I could do here.

Revise CONTRIBUTING and explain requirements (Academy course, meetings, interaction with issues) and refer to wiki, but details elsewhere

PR #1937 will tackle those changes, adding to the prerequisites and adding some links.

Read and sort wiki, Academy course and contributing again

Wiki was already done, CONTRIBUTING was is in PR #1937.
Academy still needs to be done.

Readme as an introduction, work out the collaboration section and refer to the rest https://contributing.md/how-to-build-contributing-md/

Readme collaboration section was expanded a bit but I didn't feel like it was missing so much. I provided more links for further reading, helping newcommers to identify the best articles to start with.
I don't know why the link the the contributing-best-practices website was linked here, but I used some of the suggestions when reworking the file.

@madbkr
Copy link
Contributor

madbkr commented Oct 3, 2024

This PR OpenEnergyPlatform/academy#247 is a rework for the academy course. I made changes that I believe would have aided me as a newcomer by adding to descriptions and providing more helpful links.

madbkr added a commit that referenced this issue Oct 11, 2024
…n-of-contributing-md

Update CONTRIBUTING and README #1808
@madbkr madbkr reopened this Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
To do Issues that haven't got discussed yet wiki about adding or editing the wiki
Projects
Status: Done
3 participants