-
Notifications
You must be signed in to change notification settings - Fork 207
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 README #1274
base: main
Are you sure you want to change the base?
Update README #1274
Conversation
@davide-f @hazemakhalek that is an update to introduce the levelled approach to the morning and evening developers meetings. To make the revision easier, sharing a link to the target fragment. Have also revised a bit a structure to highlight the most actively used meetings and make is possible to share a link to the description. That is a very quick draft and can definitely be improved. It would be perfect to have your opinion on that 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great point: we need to revise this README and the corresponding text in the docs.
This formulation seems a bit lengthy to me, what do you think?
What about we provide a bullet-point list guideline on how to interact for example:
- join our forum and communication platform: Discord
- Interact on Discord in the following meetings:
2.1 monthly
2.2 weeklys
2.3 specific mettings - Look at our public material on Drive [...]
- Join us and propose your stream
Or something like that? what do you think?
Totally agree! 😄 Revised, and personally I like the result much more. Though, it feels like the highest-level points could be probably better highlighted with formatting: https://github.com/ekatef/pypsa-earth/blob/update_meetings/README.md#how-to-get-involved . May you have any ideas in this regard? 🙂 |
Many thanks :) Agree that the points can be better highlighted; we could do even further probably. What about using bold to highlight keywords in the action items. Something like
It would be interesting to have an enumeration 1. 2. 3. to provide a template of guideline, like how to engage with us [without formality obviously] Almost ready to go :D Probably in the introduction of the readthedocs, we could add the bullet points too, which may help spread the world; shall we keep for another issue/contribution? |
Thank you! 😄 Revised, and the output can be checked here. I think no problem to update also readthedocs as that would have the same goal as all the previous changes, and no side effects can be expected as it's non-code PR. Just to clarify: you mean adding a structured section on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great @ekatef :D
Yeah, our readthedocs misses such informations that should be easy to reach.
Probably in the introduction, maybe after the video, a short section with the same information here proposed could help.
Not sure about the availability of max in keeping the buddy talks though; such meetings can be requested also for multiple topics beyond those but ok
README.md
Outdated
- Demand creation and prediction meeting | ||
- AI asset detection meeting | ||
- Outreach meeting for planning, discussing events, workshops, communication, community activities | ||
5. Join us and **propose you stream**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor thing
5. Join us and **propose you stream**. | |
5. Join us and **propose your stream**. |
Co-authored-by: Davide Fioriti <[email protected]>
b523d6f
to
92e1b79
Compare
Thanks for reviewing @davide-f 😄 It appears we still have had Agree for on-demand meetings, and also haven't been sure about buddy ones. Trying the next iteration, and happy to revert if you prefer. Generally, I think it may be a good idea to make sure that we have the contacts available: there may be the need to check also that the website is up to date. |
Changes proposed in this Pull Request
Update the meetings list and provide an opportunity to share a direct link to the monthly and weeklies description.
Checklist
envs/environment.yaml
anddoc/requirements.txt
.config.default.yaml
andconfig.tutorial.yaml
.test/
(note tests are changing the config.tutorial.yaml)doc/configtables/*.csv
and line references are adjusted indoc/configuration.rst
anddoc/tutorial.rst
.doc/release_notes.rst
is amended in the format of previous release notes, including reference to the requested PR.