Skip to contentSkip to conversation

Docs: add ci/kas, quick start, and release information

PATCH Applied Jon Mason 2 participants 2 messages Jun 18, 2024 – Jun 19, 2024

lore
Share & tools
lore

Jon Mason

author
#0 lore raw

PATCH 1/1 Docs: add ci/kas, quick start, and release information

---
 README.md                                     |  34 ++++--
 SECURITY.md                                   |  17 ++-
 .../continuous-integration-and-kas.md         |  67 +++++++++++
 documentation/quick-start.md                  | 105 ++++++++++++++++++
 documentation/releases.md                     |  43 +++++++
 5 files changed, 253 insertions(+), 13 deletions(-)
 create mode 100644 documentation/continuous-integration-and-kas.md
 create mode 100644 documentation/quick-start.md
 create mode 100644 documentation/releases.md
README.md +25 -9
index 0518c4efa8f9..798815270448 100644
@@ -19,19 +19,23 @@ Other Directories
 
 * ci
 
-  This directory contains gitlab continuous integration configuration files (KAS yaml files) as well as scripts needed for this
+  This directory contains gitlab continuous integration configuration files (KAS yaml files) as well as scripts needed for this.
+
+* documentation
+
+  This directory contains information on the files in this repository, building, and other relevant documents.
 
 * kas
 
-  This directory contains KAS yaml files to describe builds for systems not used in CI
+  This directory contains KAS yaml files to describe builds for systems not used in CI.
 
 * scripts
 
-  This directory contains scripts used in running the CI tests
+  This directory contains scripts used in running the CI tests.
 
 Mailing List
 ------------
-To interact with the meta-arm developer community, please email the meta-arm mailing list at [email protected]
+To interact with the meta-arm developer community, please email the meta-arm mailing list at <[email protected]>.
 Currently, it is configured to only allow emails to members from those subscribed.
 To subscribe to the meta-arm mailing list, please go to
 https://lists.yoctoproject.org/g/meta-arm
@@ -42,7 +46,7 @@ Currently, we only accept patches from the meta-arm mailing list.  For general
 information on how to submit a patch, please read
 https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
 
-E-mail [email protected] with patches created using this process. You can configure git-send-email to automatically use this address for the meta-arm repository with the following git command:
+E-mail <[email protected]> with patches created using this process. You can configure git-send-email to automatically use this address for the meta-arm repository with the following git command:
 
 `$ git config --local --add sendemail.to [email protected]`
 
@@ -55,6 +59,12 @@ The component being changed in the shortlog should be prefixed with the layer na
 
 >  arm-toolchain/gcc: enable foobar v2
 
+All contributions are under the [MIT License](/COPYING.MIT).
+
+For a quick start guide on how to build and use meta-arm, go to [quick-start.md](/documentation/quick-start.md).
+
+For information on the continuous integration done on meta-arm and how to use it, go to [continuous-integration-and-kas.md](/documentation/continuous-integration-and-kas.md).
+
 Backporting
 --------------
 Backporting patches to older releases may be done upon request, but only after a version of the patch has been accepted into the master branch.  This is done by adding the branch name to email subject line.  This should be between the square brackets (e.g., "[" and "]"), and before or after the "PATCH".  For example,
@@ -66,15 +76,21 @@ https://www.kernel.org/doc/html/latest/process/submitting-patches.html#submittin
 Releases and Release Schedule
 --------------
 We follow the Yocto Project release methodology, schedule, and stable/LTS support timelines.  For more information on these, please reference:
-https://docs.yoctoproject.org/ref-manual/release-process.html
-https://wiki.yoctoproject.org/wiki/Releases
-https://wiki.yoctoproject.org/wiki/Stable_Release_and_LTS
+* https://docs.yoctoproject.org/ref-manual/release-process.html
+* https://wiki.yoctoproject.org/wiki/Releases
+* https://wiki.yoctoproject.org/wiki/Stable_Release_and_LTS
+
+For more in-depth information on the meta-arm release and branch methodology, go to </documentation/releases.md>.
 
 Reporting bugs
 --------------
-E-mail [email protected] with the error encountered and the steps
+E-mail <[email protected]> with the error encountered and the steps
 to reproduce the issue.
 
+Security and Reporting Security Issues
+--------------
+For information on the security of meta-arm and how to report issues, please consult [SECURITY.md](/SECURITY.md).
+
 Maintainer(s)
 -------------
 * Jon Mason <[email protected]>
SECURITY.md +13 -4
index 0fa6cbcd3d15..403d62f53b81 100644
@@ -18,7 +18,7 @@ number), please contact the meta-arm mailing list at
 [email protected] and [email protected].
 
 If you are dealing with a not-yet released or urgent issue, please send a mail
-to the maintainers (see README.md) and [email protected], including as much
+to the maintainers \(see [README.md](/README.md)\) and [email protected], including as much
 detail as possible.  Encrypted emails using PGP are welcome.
 
 For more information, please visit https://developer.arm.com/support/arm-security-updates/report-security-vulnerabilities.
@@ -27,11 +27,20 @@ For more information, please visit https://developer.arm.com/support/arm-securit
 ## Branches maintained with security fixes
 
 meta-arm follows the Yocto release model, so see
-[https://wiki.yoctoproject.org/wiki/Stable_Release_and_LTS Stable release and
-LTS] for detailed info regarding the policies and maintenance of stable
+[Stable release and LTS](https://wiki.yoctoproject.org/wiki/Stable_Release_and_LTS)
+for detailed info regarding the policies and maintenance of stable
 branches.
 
-The [https://wiki.yoctoproject.org/wiki/Releases Release page] contains a list of all
+The [Release page](https://wiki.yoctoproject.org/wiki/Releases) contains a list of all
 releases of the Yocto Project. Versions in grey are no longer actively maintained with
 security patches, but well-tested patches may still be accepted for them for
 significant issues.
+
+
+# Disclaimer
+
+Arm reference solutions are Arm public example software projects that track and
+pull upstream components, incorporating their respective security fixes
+published over time. Arm partners are responsible for ensuring that the
+components they use contain all the required security fixes, if and when they
+deploy a product derived from Arm reference solutions.
documentation/continuous-integration-and-kas.md new file +67 -0

67 lines not on this page · raw message

documentation/quick-start.md new file +105 -0

105 lines not on this page · raw message

documentation/releases.md new file +43 -0

43 lines not on this page · raw message

Signature · 1 line
2.39.3 (Apple Git-146)
Applied
#1 lore raw
Quoted 1 line · Jon Mason

Applied, thanks!

[1/1] Docs: add ci/kas, quick start, and release information

      commit: 150cd18d1536381838be97d50eda0e707f600932

Best regards,

Signature · 1 line
Jon Mason <[email protected]>