From 52986a2eed14be947cfd9f9fcc719bd260ba5b5b Mon Sep 17 00:00:00 2001 From: pareenaverma Date: Sun, 17 Mar 2024 21:16:08 +0000 Subject: [PATCH 1/2] Updated README and added Issue template --- .github/ISSUE_TEMPLATE/issue-report.md | 42 ++++++++++++++++++++++++++ README.md | 31 +++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue-report.md diff --git a/.github/ISSUE_TEMPLATE/issue-report.md b/.github/ISSUE_TEMPLATE/issue-report.md new file mode 100644 index 00000000..a06d18fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-report.md @@ -0,0 +1,42 @@ +--- +name: Report an issue +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Type of issue** +- [ ] Software package information is out of date. +- [ ] Software package is not found on the list. +- [ ] Software package information is incorrect. +- [ ] Display issues +- [ ] Instructions to contribute new package data are not clear. +- [ ] Other + +**Describe the issue** +A clear and concise description of what the issue is. + +**To Reproduce** +List the steps to reproduce the behavior: + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Mobile (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/README.md b/README.md index 5a97dfdc..9f098490 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # ecosystem-dashboard-for-arm +The Arm Software Ecosystem Dashboard is available at https://www.arm.com/developer-hub/ecosystem-dashboard/servers-and-cl +oud-computing/ + +This repository is maintained by Arm and contains the source files for the Arm Software Ecosystem Dashboard, providing in +formation on software packages that work on Arm. + +This data is sourced from Arm and our wide software ecosystem. While we make our best efforts to keep this dashboard accu +rate, there are no guarantees of data correctness due to the ever-evolving software landscape. + +# How To Contribute +* To contribute new package data (or improve existing package data): + * Fork this repo and submit pull requests; follow the step by step instructions in [Contribution guidelines](/contrib.md). +* Log an issue with package data(or other general issues) + * Log a [issue on GitHub](https://github.com/ArmDeveloperEcosystem/ecosystem-dashboard-for-arm/issues) + +Note that all site content, including new contributions, is licensed under a [Creative Commons Attribution 4.0 International license](https://creativecommons.org/licenses/by/4.0/). Source repository for arm ecosystem dashboard that lists packages that work on Arm + +# Directory Structure + +This site is built on the [Hugo](https://gohugo.io/) web framework, ideal for generating static websites. Below is a brie +f description of the key files and directories: + + * /content + * contains all package source data + * /themes + * where the html elements are defined to render /content into stylized HTML + * LICENSE files + * where the license information is contained + * config.toml + * where the high-level website configuration settings are defined + From 0c94046a3a00d708f40fd336798ed5246b32f9ef Mon Sep 17 00:00:00 2001 From: pareenaverma Date: Sun, 17 Mar 2024 21:19:01 +0000 Subject: [PATCH 2/2] Updated README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9f098490..c6e51de3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # ecosystem-dashboard-for-arm -The Arm Software Ecosystem Dashboard is available at https://www.arm.com/developer-hub/ecosystem-dashboard/servers-and-cl -oud-computing/ +The Arm Software Ecosystem Dashboard is available at https://www.arm.com/developer-hub/ecosystem-dashboard/servers-and-cloud-computing/ This repository is maintained by Arm and contains the source files for the Arm Software Ecosystem Dashboard, providing in formation on software packages that work on Arm. @@ -8,7 +7,8 @@ formation on software packages that work on Arm. This data is sourced from Arm and our wide software ecosystem. While we make our best efforts to keep this dashboard accu rate, there are no guarantees of data correctness due to the ever-evolving software landscape. -# How To Contribute +# How To Contribute: + * To contribute new package data (or improve existing package data): * Fork this repo and submit pull requests; follow the step by step instructions in [Contribution guidelines](/contrib.md). * Log an issue with package data(or other general issues)