diff --git a/README.md b/README.md index 7597e50..d7b0c67 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,106 @@ - - -[![Contributors][contributors-shield]][contributors-url] -[![Forks][forks-shield]][forks-url] -[![Stargazers][stars-shield]][stars-url] -[![Last update][update-shield]][update-url] -[![Issues][issues-shield]][issues-url] -[![MIT License][license-shield]][license-url] -[![LinkedIn][linkedin-shield]][linkedin-url] - - - - -
-
- - Logo - - -

E2E OS guidance

- -

- A pan-company effort to help guide open source use and contributions sponsored by PhUSE. -
- Explore the guidance » -
-
- Report Bug or Mistake - · - Suggest improvement -

-
- - - - -## About The Project - -[![Screenshot][product-screenshot]](https://phuse-org.github.io/E2E-OS-Guidance/) - -This guidance was built through the contributions of [individuals across multiple companies](https://phuse-org.github.io/E2E-OS-Guidance/contributors.html). Please use the issues to -reach out if you have suggestions to improve this document. - -

(back to top)

- - - - -## Rebuilding this site - -### Installation - -1. Make a branch, apply your edits and then make a pull request (PR) onto main -2. The website is built and deployed from a gh-action, so you do not need to pre-render -3. If you would like to see what the website looks like before making a PR, you can navigate to the folder on your clone and run `quarto preview`. - -

(back to top)

- - - - -## Contributing - -Contributions are what make this document valuable. Please reach out via the issues, -ask a co-lead, or get in [contact with PhUSE](https://phuse.global/Community/Get_Involved). - - - - -## License - -Distributed under the MIT License. See `LICENSE` for more information. - -

(back to top)

- - - -[contributors-shield]: https://img.shields.io/github/contributors/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge -[contributors-url]: https://github.com/phuse-org/E2E-OS-Guidance/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge -[forks-url]: https://github.com/phuse-org/E2E-OS-Guidance/network/members -[update-shield]: https://img.shields.io/github/last-commit/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge -[update-url]: https://github.com/phuse-org/E2E-OS-Guidance -[stars-shield]: https://img.shields.io/github/stars/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge -[stars-url]: https://github.com/phuse-org/E2E-OS-Guidance/stargazers -[issues-shield]: https://img.shields.io/github/issues/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge -[issues-url]: https://github.com/phuse-org/E2E-OS-Guidance/issues -[license-shield]: https://img.shields.io/github/license/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge -[license-url]: https://github.com/phuse-org/E2E-OS-Guidance/blob/main/LICENSE -[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 -[linkedin-url]: https://www.linkedin.com/company/phuse/ -[product-screenshot]: assets/screenshot.png + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Last update][update-shield]][update-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] + + + + +
+
+ + Logo + + +

E2E OS guidance

+ +

+ A pan-company effort to help guide open source use and contributions sponsored by PhUSE. +
+ Explore the guidance » +
+
+ Report Bug or Mistake + · + Suggest improvement +

+
+ + + + +## About The Project + +[![Screenshot][product-screenshot]](https://phuse-org.github.io/E2E-OS-Guidance/) + +This guidance was built through the contributions of [individuals across multiple companies](https://phuse-org.github.io/E2E-OS-Guidance/contributors.html). Please use the issues to +reach out if you have suggestions to improve this document. + +

(back to top)

+ + +## Contributing + +Contributions are what make this document valuable. Please reach out via the issues, +ask a co-lead, contribute directly, or get in [contact with PhUSE](https://phuse.global/Community/Get_Involved). + +### Direct contribution + +If you want to contribute to the documents directly you can: + + 1. Fork the project + 1. Clone the fork to your machine + 1. Make a branch + 1. Apply your edits and commit + 1. Push your change to your fork + 1. Create a pull request (PR) onto main + +### Rebuilding this site + +The website is built and deployed automatically with GitHub Actions, so there is no formal need to pre-render before contributing. However, if you would like to see the rendered website looks **before** making a PR, you can either + + * Navigate to the folder on your clone and run `quarto preview`, provided you have [quarto](https://quarto.org/) installed, + +or + + 1. Open the `E2E-OS-Guidance.Rproj` in RStudio (sufficiently new) + 1. Open the `index.qmd` file + 1. Press "Render". + +

(back to top)

+ + +## License + +Distributed under the MIT License. See `LICENSE` for more information. + +

(back to top)

+ + + +[contributors-shield]: https://img.shields.io/github/contributors/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge +[contributors-url]: https://github.com/phuse-org/E2E-OS-Guidance/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge +[forks-url]: https://github.com/phuse-org/E2E-OS-Guidance/network/members +[update-shield]: https://img.shields.io/github/last-commit/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge +[update-url]: https://github.com/phuse-org/E2E-OS-Guidance +[stars-shield]: https://img.shields.io/github/stars/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge +[stars-url]: https://github.com/phuse-org/E2E-OS-Guidance/stargazers +[issues-shield]: https://img.shields.io/github/issues/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge +[issues-url]: https://github.com/phuse-org/E2E-OS-Guidance/issues +[license-shield]: https://img.shields.io/github/license/phuse-org/E2E-OS-Guidance.svg?style=for-the-badge +[license-url]: https://github.com/phuse-org/E2E-OS-Guidance/blob/main/LICENSE +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://www.linkedin.com/company/phuse/ +[product-screenshot]: assets/screenshot.png