diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index 40fefae..897643b 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -14,7 +14,7 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} - name: Fetch git repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: fetch-depth: 0 path: website diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml index 1a672d3..1afc4cb 100644 --- a/.github/workflows/push.yml +++ b/.github/workflows/push.yml @@ -15,7 +15,7 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} - name: Fetch git repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: path: website diff --git a/_config.yml b/_config.yml index 4b7486f..083280f 100644 --- a/_config.yml +++ b/_config.yml @@ -120,10 +120,13 @@ avatar_placeholder: /assets/images/avatar-placeholder.jpg post_placeholder: /assets/images/content/linaro-logo.png # Social Media Links social_media_channels: - github: false - linkedin: false + github: + url: https://github.com/OpenAMP + linkedin: + url: https://www.linkedin.com/company/openamp facebook: false - youtube: false + youtube: + url: https://youtube.com/@openamp twitter: false instagram: false # Disqus Comments Setup diff --git a/_data/footer.yml b/_data/footer.yml index ba21dd0..572eece 100644 --- a/_data/footer.yml +++ b/_data/footer.yml @@ -4,7 +4,7 @@ copyright_text: Linaro footer_brand: logo: /assets/images/Linaro-logo-white.png # Social Media Icons Row -social-media-icons: false +social-media-icons: true # Display the contact details section display-contact-details: false # These links are displayed at the very bottom of the footer. @@ -14,23 +14,21 @@ company_links: - name: Contact url: https://www.linaro.org/contact/ first_column: - title: GitHub Projects + title: Getting Started items: - - title: open-amp - url: https://github.com/OpenAMP/open-amp - - title: libmetal - url: https://github.com/OpenAMP/libmetal - - title: meta-openamp - url: https://github.com/OpenAMP/meta-openamp - - title: lopper - url: https://github.com/devicetree-org/lopper + - title: OpenAMP Project documentation + url: https://openamp.readthedocs.io/en/latest/index.html + - title: Reference samples and demos + url: https://openamp.readthedocs.io/en/latest/demos/index.html + - title: OpenAMP mailing lists + url: https://lists.openampproject.org/mailman3/lists/?all-lists + - title: OpenAMP community Discord + url: https://discord.gg/8quFQBWq42 second_column: title: Useful Links items: - title: OpenAMP call meeting notes url: https://github.com/OpenAMP/open-amp/wiki#Meeting_Notes - - title: OpenAMP mailing lists - url: https://lists.openampproject.org/mailman3/lists/?all-lists - title: OpenAMP project governance url: /governance/ - title: OpenAMP code of conduct diff --git a/_includes/openamp-jumbotron.html b/_includes/openamp-jumbotron.html index ca3bce7..a442dac 100644 --- a/_includes/openamp-jumbotron.html +++ b/_includes/openamp-jumbotron.html @@ -13,7 +13,7 @@

- + View on Github

diff --git a/_pages/governance.md b/_pages/governance.md index 61d30ea..2ee9018 100644 --- a/_pages/governance.md +++ b/_pages/governance.md @@ -36,7 +36,7 @@ The OpenAMP Working Groups are currently: - OpenAMP Remoteproc (a.k.a. OpenAMP classic) - System Device Tree -- Application Services +- System reference To be notified of working group calls, please subscribe to the corresponding working group mailing list [via the OpenAMP Project mailing lists page][openamp mailing lists page]. @@ -60,6 +60,12 @@ Published at the OpenAMP [code of conduct][code of conduct] page. # Development Process +The development process in this section applies to the libmetal and open-amp libraries and any RTOS code in openamp-system-reference. + +The pull request model applies to all OpenAMP repositories, except from the kernel-staging repository. + +The kernel staging repository accepts only pull request from OpenAMP maintainers. Patches for the kernel should be sent to the [linux-remoteproc@vger.kernel.org](mailto:linux-remoteproc@vger.kernel.org) mailing list. + ## Maintainers Maintainers are nominated and voted upon by the TSC. They should be the only ones who can commit to the repositories. As with everyone else, they must use Pull Requests. @@ -70,7 +76,7 @@ Maintainers are nominated and voted upon by the TSC. They should be the only one ### Coding Style -OpenAMP uses the [Zephyr coding style][zephyr coding style] and uses the checkpatch.pl script to automatically review and leave comments on pull requests (continuous integration process). (2020-02-20) +New OpenAMP code should follow the [Zephyr coding style][zephyr coding style] and uses the checkpatch.pl script to automatically review and leave comments on pull requests (continuous integration process). (2020-02-20) ### MISRA C @@ -78,7 +84,7 @@ OpenAMP uses the [Zephyr coding style][zephyr coding style] and uses the checkpa ### C Version -To be discussed. C11? +To be discussed. C99? ## Development Workflow @@ -98,7 +104,7 @@ Proposed new features should be discussed actively on the mailing list and the t ### Testing -For a new feature, an application or test must be provided so that we can test that the feature works & continues to be valid in the future. +For a new feature: an application or test must be provided so that we can test that the feature works & continues to be valid in the future. OpenAMP CI is relying on the checkpatch tool, using Zephyr coding rules. @@ -106,19 +112,18 @@ TO DO: Add guidelines once they get baked ### Documentation -Sphinx was proposed and is under consideration (2020-05-12) - -Topic to be revisited. +Sphinx and Doxygen are used. +The Documentation has to be be updated for any new feature or API update. ## Branching and Tagging Strategy -### Development on master +### Development on main -The master branch is where all accepted changes are first committed. The CI loop is primarily focused on this branch. +The main branch is where all accepted changes are first committed. The CI loop is primarily focused on this branch. ### Release branches -A release branch is created from the master branch at the time of feature freeze for the release. +A release branch is created from the main branch on the release, for maintenance. ### Release Tags @@ -128,11 +133,11 @@ At the time of the release, the release branch will be tagged. This will help en ### Release Frequency -Releases will be twice yearly, in the spring and fall (usually mid-April and mid-October). +Releases will be twice yearly, in the spring and fall (usually end of April and end of October). ### Naming Conventions -Releases will be named yyyy.mm (e.g. 2019.10). +Releases will be named yyyy.mm.n (e.g. 2019.10.0). ### Release Process @@ -144,14 +149,16 @@ This is for discussion and development of new features. It starts as soon as the #### Feature Freeze -This occurs at about the four-month mark in the release cycle. The release branch is created from the master at this point. +This occurs at about the five-month mark in the release cycle. The release branch is created from the main at this point. #### Debug -After Feature Freeze, no new features can be committed to the release branch, only bug fixes. +This occurs at about the five-month mark in the release cycle +After Feature Freeze, no new features are committed until the release, only bug fixes. #### Code Freeze +This occurs at about fifteen days before the release At this time, no further commits may be made to the release branch unless they fix a critical bug found in testing. #### Release @@ -176,7 +183,7 @@ Specifically out of scope would be the APIs internal to the Linux kernel. The Li #### Adding New APIs -TBD +An update of the API shall not break the existing one. When possible a new API should be created instead of updating the existing one, else the deprecating APIs process described below shall be applied. #### Deprecating Existing APIs @@ -194,13 +201,9 @@ This is being discussed on the TSC mailing list in the [thread "API and Wire pro ## Certification Concerns -### Safety - -TBD - -### Security +### Security and Safety -TBD +We expect OpenAMP libraries will be used in security and safety sensitive areas. OpenAMP will align to reasonable requirements as they become clear. [openamp mailing lists page]: http://lists.openampproject.org [openamp meeting notes page]: https://github.com/OpenAMP/open-amp/wiki/Meeting-Notes