diff --git a/7-contributing/CONDUCT.md b/7-contributing/CONDUCT.md deleted file mode 100644 index 922ba821d..000000000 --- a/7-contributing/CONDUCT.md +++ /dev/null @@ -1,13 +0,0 @@ -# Contributor Code of Conduct - -As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. - -We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. - -Examples of unacceptable behaviour by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. - -Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by opening an issue or contacting one or more of the project maintainers. - -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.0.0, available at [https://contributor-covenant.org/version/1/0/0/](https://www.contributor-covenant.org/version/1/0/0/). diff --git a/7-contributing/CONDUCT.md b/7-contributing/CONDUCT.md new file mode 120000 index 000000000..0400d5746 --- /dev/null +++ b/7-contributing/CONDUCT.md @@ -0,0 +1 @@ +../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/7-contributing/LICENSE.md b/7-contributing/LICENSE.md deleted file mode 100644 index 9026cc60b..000000000 --- a/7-contributing/LICENSE.md +++ /dev/null @@ -1,50 +0,0 @@ -# License - -## Instructional Material - -All instructional material is made available under the [Creative Commons -Attribution license][cc-by-human]. The following is a human-readable summary of -(and not a substitute for) the [full legal text of the CC BY 4.0 -license][cc-by-legal]. - -You are free to: - -* to **Share** --- copy and redistribute the material in any medium or format -* to **Adapt** --- remix, transform, and build upon the material for any - purpose, even commercially. - -The licensor cannot revoke these freedoms as long as you follow the license -terms. - -Under the following terms: - -* **Attribution** --- You must give appropriate credit, provide a [link to the - license][cc-by-human], and indicate if changes were made. You may do so in - any reasonable manner, but not in any way that suggests the licensor endorses - you or your use. - -* **No additional restrictions** --- You may not apply legal terms or - technological measures that legally restrict others from doing anything the - license permits. - -Notices: - -* You do not have to comply with the license for elements of the material in - the public domain or where your use is permitted by an applicable exception - or limitation. -* No warranties are given. The license may not give you all of the permissions - necessary for your intended use. For example, other rights such as publicity, - privacy, or moral rights may limit how you use the material. - - -## Software - -Except where otherwise noted, the example programs and other software provided -by FCC Software are made available under the [OSI][osi]-approved -[Apache 2.0][apache-license] license. - - -[cc-by-human]: https://creativecommons.org/licenses/by/4.0/ -[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode -[apache-license]: https://opensource.org/license/apache-2-0/ -[osi]: https://opensource.org diff --git a/7-contributing/LICENSE.md b/7-contributing/LICENSE.md new file mode 120000 index 000000000..7eabdb1c2 --- /dev/null +++ b/7-contributing/LICENSE.md @@ -0,0 +1 @@ +../LICENSE.md \ No newline at end of file diff --git a/7-contributing/README.md b/7-contributing/README.md deleted file mode 100644 index b06e3c6c4..000000000 --- a/7-contributing/README.md +++ /dev/null @@ -1,114 +0,0 @@ -(contributing-lesson)= -# Contributing - -[FCC Software][fcc-software] tutorials, as well as the whole [Key4hep][key4hep] -ecosystem, is an open source project, and we welcome contributions of all kinds: - -* New lessons; -* Fixes to existing material; -* Bug reports; and -* Reviews of proposed changes. - -By contributing, you are agreeing that we may redistribute your work under -[these licenses][license]. -You also agree to abide by our [contributor code of conduct][conduct]. - - -## Getting Started - -1. We use the [fork and pull][gh-fork-pull] model to manage changes. - GitHub also provides more information about [forking a repository][gh-fork] - and [making a Pull Request][gh-pull] on their website. - -2. For our lessons, you should branch from and submit pull requests against - the `main` branch. - -3. When editing lesson pages, you need to only commit changes to the Markdown - source files. - -4. To build the tutorials please follow the - [instructions](#building-the-tutorials). - -5. If you're looking for things to work on, please see - [the list of issues for this repository][issues]. Comments on issues and - reviews of pull requests are equally welcome. - - -## Building the tutorials - -### Requirements - -Make sure you have `venv` (virtual environment) in your working directory. It -can be created with the following command: -```bash -python3 -m venv venv -``` -Activate it in your shell and install the requirements, which are gathered in a -file provided by the repository. -```bash -source venv/bin/activate -pip3 install -r requirements.txt -``` -After sourcing, your shell prompt will be augmented by the `(venv)` prefix, e.g. -``` -(venv) mylaptop:~/fcc/fcc-tutorials -``` - -:::{admonition} Building `fcc-tutorials` in the Key4hep stack -:class: callout dropdown - -In case you are editing the tutorials using the FCC Software (Key4hep) stack, it -is necessary to clear the `PYTHONPATH` environment variable after sourcing of -the stack -```bash -source /cvmfs/fcc.cern.ch/sw/latest/setup.sh -unset PYTHONPATH -``` - -Using of the FCCSW stack might also be needed in cases when the Python provided -by your OS is too old. -::: - -### Building - -The documentation pages are build by executing -```bash -sphinx-build -b html . build -``` - -### Browsing the result - -Start a web server to host the generated files from `build` directory -```bash -python -m http.server -d build -``` - -You should be able to see your local version by opening a web-browser and -navigating to [http://localhost:8000](http://localhost:8000). - - -## How to Write - -More information about how to write the tutorials for the FCC Software visit -[](./../6-developing-fccsw/FccDocPage.md#how-to-write-mardown). - - -## Legal - -```{eval-rst} -.. toctree:: - - CONDUCT.md - LICENSE.md -``` - - -[fcc-software]: https://fccsw.web.cern.ch/ -[key4hep]: https://key4hep.web.cern.ch/ -[conduct]: CONDUCT.md -[license]: LICENSE.md -[issues]: https://github.com/HEP-FCC/fcc-tutorials/issues -[pro-git-chapter]: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project -[gh-fork]: https://help.github.com/en/articles/fork-a-repo -[gh-pull]: https://help.github.com/en/articles/about-pull-requests -[gh-fork-pull]: https://reflectoring.io/github-fork-and-pull/ diff --git a/7-contributing/README.md b/7-contributing/README.md new file mode 120000 index 000000000..44fcc6343 --- /dev/null +++ b/7-contributing/README.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..922ba821d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,13 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. + +Examples of unacceptable behaviour by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. + +Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.0.0, available at [https://contributor-covenant.org/version/1/0/0/](https://www.contributor-covenant.org/version/1/0/0/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..605b5a299 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,114 @@ +(contributing-lesson)= +# Contributing + +[FCC Software][fcc-software] tutorials, as well as the whole [Key4hep][key4hep] +ecosystem, is an open source project, and we welcome contributions of all kinds: + +* New lessons; +* Fixes to existing material; +* Bug reports; and +* Reviews of proposed changes. + +By contributing, you are agreeing that we may redistribute your work under +[these licenses][license]. +You also agree to abide by our [contributor code of conduct][conduct]. + + +## Getting Started + +1. We use the [fork and pull][gh-fork-pull] model to manage changes. + GitHub also provides more information about [forking a repository][gh-fork] + and [making a Pull Request][gh-pull] on their website. + +2. For our lessons, you should branch from and submit pull requests against + the `main` branch. + +3. When editing lesson pages, you need to only commit changes to the Markdown + source files. + +4. To build the tutorials please follow the + [instructions](#building-the-tutorials). + +5. If you're looking for things to work on, please see + [the list of issues for this repository][issues]. Comments on issues and + reviews of pull requests are equally welcome. + + +## Building the tutorials + +### Requirements + +Make sure you have `venv` (virtual environment) in your working directory. It +can be created with the following command: +```bash +python3 -m venv venv +``` +Activate it in your shell and install the requirements, which are gathered in a +file provided by the repository. +```bash +source venv/bin/activate +pip3 install -r requirements.txt +``` +After sourcing, your shell prompt will be augmented by the `(venv)` prefix, e.g. +``` +(venv) mylaptop:~/fcc/fcc-tutorials +``` + +:::{admonition} Building `fcc-tutorials` in the Key4hep stack +:class: callout dropdown + +In case you are editing the tutorials using the FCC Software (Key4hep) stack, it +is necessary to clear the `PYTHONPATH` environment variable after sourcing of +the stack +```bash +source /cvmfs/sw.hsf.org/key4hep/setup.sh +unset PYTHONPATH +``` + +Using of the FCCSW stack might also be needed in cases when the Python provided +by your OS is too old. +::: + +### Building + +The documentation pages are build by executing +```bash +sphinx-build -b html . build +``` + +### Browsing the result + +Start a web server to host the generated files from `build` directory +```bash +python -m http.server -d build +``` + +You should be able to see your local version by opening a web-browser and +navigating to [http://localhost:8000](http://localhost:8000). + + +## How to Write + +More information about how to write the tutorials for the FCC Software visit +[](./../6-developing-fccsw/FccDocPage.md#how-to-write-mardown). + + +## Legal + +```{eval-rst} +.. toctree:: + + CONDUCT.md + LICENSE.md +``` + + +[fcc-software]: https://fccsw.web.cern.ch/ +[key4hep]: https://key4hep.web.cern.ch/ +[conduct]: CONDUCT.md +[license]: LICENSE.md +[issues]: https://github.com/HEP-FCC/fcc-tutorials/issues +[pro-git-chapter]: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project +[gh-fork]: https://help.github.com/en/articles/fork-a-repo +[gh-pull]: https://help.github.com/en/articles/about-pull-requests +[gh-fork-pull]: https://reflectoring.io/github-fork-and-pull/ \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..9026cc60b --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,50 @@ +# License + +## Instructional Material + +All instructional material is made available under the [Creative Commons +Attribution license][cc-by-human]. The following is a human-readable summary of +(and not a substitute for) the [full legal text of the CC BY 4.0 +license][cc-by-legal]. + +You are free to: + +* to **Share** --- copy and redistribute the material in any medium or format +* to **Adapt** --- remix, transform, and build upon the material for any + purpose, even commercially. + +The licensor cannot revoke these freedoms as long as you follow the license +terms. + +Under the following terms: + +* **Attribution** --- You must give appropriate credit, provide a [link to the + license][cc-by-human], and indicate if changes were made. You may do so in + any reasonable manner, but not in any way that suggests the licensor endorses + you or your use. + +* **No additional restrictions** --- You may not apply legal terms or + technological measures that legally restrict others from doing anything the + license permits. + +Notices: + +* You do not have to comply with the license for elements of the material in + the public domain or where your use is permitted by an applicable exception + or limitation. +* No warranties are given. The license may not give you all of the permissions + necessary for your intended use. For example, other rights such as publicity, + privacy, or moral rights may limit how you use the material. + + +## Software + +Except where otherwise noted, the example programs and other software provided +by FCC Software are made available under the [OSI][osi]-approved +[Apache 2.0][apache-license] license. + + +[cc-by-human]: https://creativecommons.org/licenses/by/4.0/ +[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode +[apache-license]: https://opensource.org/license/apache-2-0/ +[osi]: https://opensource.org diff --git a/conf.py b/conf.py index bbae4cedb..6f8261896 100644 --- a/conf.py +++ b/conf.py @@ -10,6 +10,8 @@ 'venv', '.github', 'README.md', + 'CONTRIBUTING.md', + 'LICENSE.md', 'archive' ]