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 README #1274

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Update README #1274

wants to merge 11 commits into from

Conversation

ekatef
Copy link
Member

@ekatef ekatef commented Jan 1, 2025

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

  • I consent to the release of this PR's code under the AGPLv3 license and non-code contributions under CC0-1.0 and CC-BY-4.0.
  • I tested my contribution locally and it seems to work fine.
  • Code and workflow changes are sufficiently documented.
  • Newly introduced dependencies are added to envs/environment.yaml and doc/requirements.txt.
  • Changes in configuration options are added in all of config.default.yaml and config.tutorial.yaml.
  • Add a test config or line additions to test/ (note tests are changing the config.tutorial.yaml)
  • Changes in configuration options are also documented in doc/configtables/*.csv and line references are adjusted in doc/configuration.rst and doc/tutorial.rst.
  • A note for the release notes doc/release_notes.rst is amended in the format of previous release notes, including reference to the requested PR.

@ekatef
Copy link
Member Author

ekatef commented Jan 1, 2025

@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 🙂

Copy link
Member

@davide-f davide-f left a 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:

  1. join our forum and communication platform: Discord
  2. Interact on Discord in the following meetings:
    2.1 monthly
    2.2 weeklys
    2.3 specific mettings
  3. Look at our public material on Drive [...]
  4. Join us and propose your stream

Or something like that? what do you think?

@ekatef
Copy link
Member Author

ekatef commented Jan 2, 2025

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:

  1. join our forum and communication platform: Discord
  2. Interact on Discord in the following meetings:
    2.1 monthly
    2.2 weeklys
    2.3 specific mettings
  3. Look at our public material on Drive [...]
  4. 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? 🙂

@davide-f
Copy link
Member

davide-f commented Jan 3, 2025

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:

  1. join our forum and communication platform: Discord
  2. Interact on Discord in the following meetings:
    2.1 monthly
    2.2 weeklys
    2.3 specific mettings
  3. Look at our public material on Drive [...]
  4. 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

  1. Join our forum and communication channel
  2. Chat on Discord with us ...
  3. ...

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?

@ekatef
Copy link
Member Author

ekatef commented Jan 4, 2025

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

  1. Join our forum and communication channel
  2. Chat on Discord with us ...
  3. ...

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 How to join on the top of Introduction section?

Copy link
Member

@davide-f davide-f left a 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**.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor thing

Suggested change
5. Join us and **propose you stream**.
5. Join us and **propose your stream**.

@ekatef
Copy link
Member Author

ekatef commented Jan 14, 2025

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

Thanks for reviewing @davide-f 😄

It appears we still have had Get Involved part in readthedocs, I just missed to update it. Should be fixed now though a final polishing of the format may still be needed.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants