FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Document microgrid concepts from an SDK perspective by shsms · Pull Request #722 · frequenz-floss/frequenz-sdk-python · GitHub

  1. frequenz-floss
  2. frequenz-sdk-python

Repository navigation

Document microgrid concepts from an SDK perspective - #722

Merged
shsms merged 7 commits into
frequenz-floss:v1.x.xfrom
shsms:microgrid-concepts
Oct 18, 2023
ConversationCommits (7)ChecksFiles changed
Merged

Document microgrid concepts from an SDK perspective#722
shsms merged 7 commits into
frequenz-floss:v1.x.xfrom
shsms:microgrid-concepts

Conversation

shsms commented Oct 12, 2023

Copy link
Copy Markdown
Contributor

Closes #456

shsms requested a review from a team as a code owner October 12, 2023 15:19
github-actions Bot added part:docs Affects the documentation part:data-pipeline Affects the data pipeline labels Oct 12, 2023

shsms commented Oct 12, 2023

Copy link
Copy Markdown
Contributor Author

Does this one need release notes?

daniel-zullo-frequenz added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Oct 12, 2023
llucax reviewed Oct 13, 2023
View reviewed changes
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md
Comment thread docs/user-guide/microgrid-concepts.md
Comment thread docs/user-guide/microgrid-concepts.md Outdated
daniel-zullo-frequenz reviewed Oct 13, 2023
View reviewed changes

daniel-zullo-frequenz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I have a few cosmetics to check for

Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
shsms added 5 commits October 16, 2023 16:09
Update mkdocs macro glossary to take optional link text
f322b1f 
This allows linking to a glossary term with custom text for the link.

Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
Add a user guide explaining microgrid concepts from an SDK perspective
745689c 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
Remove boiler-plate code from LogicalMeter example
70933b5 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
Link PSC to detailed entry in glossary
1227c0f 
Also add some specifics about passive sign convention from the point
of view of the grid connection.

And fix a typo.

Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
Improve grammar and tone
2021740 
Based on review comments

Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
shsms commented Oct 17, 2023
View reviewed changes

shsms left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Added a commit with the changes

Comment thread docs/user-guide/microgrid-concepts.md
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
Comment thread docs/user-guide/microgrid-concepts.md Outdated
shsms force-pushed the microgrid-concepts branch from 52e5dfe to 2021740 Compare October 17, 2023 09:49
github-actions Bot added the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Oct 17, 2023
daniel-zullo-frequenz reviewed Oct 17, 2023
View reviewed changes

daniel-zullo-frequenz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, I'll leave it to Luca to approve it as he still needs to resolve his comments

github-actions Bot added the part:microgrid Affects the interactions with the microgrid label Oct 17, 2023
shsms force-pushed the microgrid-concepts branch from 43a88c3 to 20c271b Compare October 17, 2023 14:22
shsms mentioned this pull request Oct 17, 2023
Open
llucax mentioned this pull request Oct 18, 2023
Closed
1 task
llucax previously approved these changes Oct 18, 2023
View reviewed changes

llucax left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I strongly recommend adding a comment but I'm fine to merge as is too.

Comment thread docs/_scripts/macros.py
glossary_path = pathlib.Path("user-guide/glossary.md")
link_path = glossary_path.relative_to(current_path.parent)
return f"[{term}]({link_path}#{_slugify(term)})"
link_path = os.path.relpath(glossary_path, current_path.parent)

llucax Oct 18, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Mmm, interesting. I would add a comment about this because it's not obvious at all so I wouldn't be surprised if someone wants to change it back.

shsms Oct 18, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

done

shsms added 2 commits October 18, 2023 10:35
Replace pathlib.Path.relative_to with os.path.relpath
3f81f2c 
The `pathlib` method expects one path to be the sub path of the other.
The `os.path` function is able to find a relative path even if they
diverge, by adding `../`.

Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
Move microgrid docs to the module and reference it in the user guide
6add297 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
shsms force-pushed the microgrid-concepts branch from 20c271b to 6add297 Compare October 18, 2023 08:35
shsms added this pull request to the merge queue Oct 18, 2023
Merged via the queue into frequenz-floss:v1.x.x with commit 0fb0e58 Oct 18, 2023
shsms deleted the microgrid-concepts branch October 18, 2023 11:11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

daniel-zullo-frequenz daniel-zullo-frequenz approved these changes
llucax llucax left review comments

Assignees

No one assigned

Labels

cmd:skip-release-notes It is not necessary to update release notes for this PR part:data-pipeline Affects the data pipeline part:docs Affects the documentation part:microgrid Affects the interactions with the microgrid part:tooling Affects the development tooling (CI, deployment, dependency management, etc.)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Basic microgrid concepts and component graph

3 participants

Back | FazBrowse Home | New Git URL