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

Documentation Update and Restructure : remaining tasks #38

Open
5 of 28 tasks
arnopo opened this issue Jan 17, 2025 · 0 comments · May be fixed by #41, #40 or #39
Open
5 of 28 tasks

Documentation Update and Restructure : remaining tasks #38

arnopo opened this issue Jan 17, 2025 · 0 comments · May be fixed by #41, #40 or #39

Comments

@arnopo
Copy link
Collaborator

arnopo commented Jan 17, 2025

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/

Repositories that no more up to date and need clean up

sipke pushed a commit to sipke/openamp-docs that referenced this issue Jan 20, 2025
@sipke sipke linked a pull request Jan 20, 2025 that will close this issue
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."
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
Labels
None yet
Projects
None yet
1 participant