-
Notifications
You must be signed in to change notification settings - Fork 10
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
Documentation Update and Restructure : remaining tasks #38
Open
5 of 28 tasks
Comments
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 20, 2025
review request. Refer issue 38 OpenAMP#38
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 Remove "once loaded and started using Remoteproc."
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 Remove or set optional resource table in demo diagrams. replace remoteproc by remoteproc virtio in message diagrams. Change diagrom to use Main processor terminology for main/host computer.
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 change reference to code from opena-amp repository to openamp-system repository
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 Proxy and RPC chapter should be renamed Rpmsg service. Did not remove Proxy yet, as still "to discuss if we keep the proxy service that is not generic."
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 Remove "once loaded and started using Remoteproc."
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 Remove or set optional resource table in demo diagrams. replace remoteproc by remoteproc virtio in message diagrams. Change diagrom to use Main processor terminology for main/host computer.
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 change reference to code from opena-amp repository to openamp-system repository
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Jan 27, 2025
Refer issue 38: OpenAMP#38 Proxy and RPC chapter should be renamed Rpmsg service. Did not remove Proxy yet, as still "to discuss if we keep the proxy service that is not generic."
This was
linked to
pull requests
Feb 6, 2025
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: move "If you want to contribute and port OpenAMP to your platform read more about OpenAMP porting here." to contributing page
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: add link to the virtio spec
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: to rewrite this chapter ( remove standardization notions).
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Most of this page is in governance, so remove most and leave only more specific links to other sections providing more specific details on how to contribute. Refer issue 38: OpenAMP#38 Addressing review comments: * Avoid duplication with https://www.openampproject.org/governance/ in this pages. to determine if a part of the gouvernance should be moved ghere * no roadmap defined, to remove chapter * no platform maintainer defined, to remove chapter and/or rewrite according to gouvernance page
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: "History" to move to OpenAMp project part?
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comments: * "input ring buffer" and "free ring buffer" is not really current terminology in Virtio lingo. Maybe just keep the standard used and available terminology. * It's not clear from the title of this image that it refers to the available ring buffer.
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: * The fastest fix is to remove the last phrase which mentions the "referred to as a hypervisorless-virtio" statement.
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: NXP i.MX8M Plus is also supported.
sipke
pushed a commit
to sipke/openamp-docs
that referenced
this issue
Feb 17, 2025
Refer issue 38: OpenAMP#38 Address review comment: NXP i.MX8M Plus is also supported.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Based on #37, the aim of this issue is to list items that should be addressed in the scope of the documentation restructuring. This list needs to be discussed and can potentially be extended with new comments.
Reference of the documentation used as input: https://openamp.readthedocs.io/en/main-next/
https://openamp.readthedocs.io/en/main-next/openamp/overview.html#openamp-architecture
https://openamp.readthedocs.io/en/main-next/openamp/overview.html#project-aims
https://openamp.readthedocs.io/en/main-next/openamp/overview.html#operating-environments
addressed in A few fixes on top of the main-next branch #39
https://openamp.readthedocs.io/en/main-next/openamp/overview.html#openamp-governance-and-guidelines
https://openamp.readthedocs.io/en/main-next/openamp/contributing.html
https://openamp.readthedocs.io/en/main-next/openamp/contributing.html#roadmap-discussion-and-publication
https://openamp.readthedocs.io/en/main-next/openamp/contributing.html#platform-maintainers
https://openamp.readthedocs.io/en/main-next/demos/demos_index.html
Changes A for Issue 38 #41
Changes A for Issue 38 #41
remoteproc
byremoteproc virtio
in message diagrams. the remoteproc virtio is the virtio transport layer ( similar to virtio MMIO)Changes A for Issue 38 #41
https://openamp.readthedocs.io/en/main-next/protocol_details/index.html
https://openamp.readthedocs.io/en/main-next/protocol_details/components.html
Changes A for Issue 38 #41
https://openamp.readthedocs.io/en/main-next/open-amp/doc/remoteproc-design.html
https://openamp.readthedocs.io/en/main-next/open-amp/doc/rpmsg-design.html
https://openamp.readthedocs.io/en/main-next/docs/data_structures.html
demos/reference_boards.rst
NXP i.MX8M Plus was also added
Documentation Update and Restructure #37 (comment)
demos/rpmsg_multi_services.rst
NXP i.MX8M Plus is also supported.
Documentation Update and Restructure #37 (comment)
Complete Glossary
Documentation Update and Restructure #37 (comment)
openamp/overview.rst
Add PMM for hypervisorless virtio in architecture (openamp/overview.rst) ?
sync on an appropriate rephrasing.
Documentation Update and Restructure #37 (comment)
rpmsg_protocol.rst
"input ring buffer" and "free ring buffer" is not really current terminology in Virtio lingo. Maybe just keep the standard used and available terminology.
Documentation Update and Restructure #37 (comment)
It's not clear from the title of this image that it refers to the available ring buffer.
Documentation Update and Restructure #37 (comment).
Repositories that no more up to date and need clean up
The text was updated successfully, but these errors were encountered: