From f8eaf149f691bea59745cec8e60d374b79e7ff1d Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Wed, 31 Jul 2024 12:41:33 +0200 Subject: [PATCH] revert changes; fix rendering issues --- AUTHORS.md | 2 - CONTRIBUTING.md | 4 +- docs/make.jl | 4 +- docs/src/man/authors.md | 27 ------- docs/src/man/code_of_conduct.md | 137 -------------------------------- docs/src/man/contributing.md | 59 -------------- docs/src/man/installation.md | 2 +- docs/src/man/license.md | 27 ------- docs/src/man/security.md | 30 ------- 9 files changed, 4 insertions(+), 288 deletions(-) delete mode 100644 docs/src/man/authors.md delete mode 100644 docs/src/man/code_of_conduct.md delete mode 100644 docs/src/man/contributing.md delete mode 100644 docs/src/man/license.md delete mode 100644 docs/src/man/security.md diff --git a/AUTHORS.md b/AUTHORS.md index 29082db9..05415e73 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -23,5 +23,3 @@ are listed in alphabetical order: * Patrick Sanan * Hendrik Ranocha * Ludovic Räss -* Ivan Utkin -* Samuel Omlin diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ebd24e7..dbafbc66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing `JustRelax.jl` is an open-source project and we are very happy to accept contributions -from the community. Please feel free to open issues or submit patches (preferably -as pull requests) any time. For planned larger contributions, it is often +from the community. Please feel free to [open issues](https://github.com/PTsolvers/JustRelax.jl/issues/new) or submit patches (preferably +as [pull requests](https://github.com/PTsolvers/JustRelax.jl/pulls)) any time. For planned larger contributions, it is often beneficial to get in contact with one of the principal developers first (see [AUTHORS.md](AUTHORS.md)). diff --git a/docs/make.jl b/docs/make.jl index 55de6289..f5e9ba26 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -58,12 +58,10 @@ open(joinpath(@__DIR__, "src", "man", "contributing.md"), "w") do io ``` """) # Write the modified contents - println(io, "# [Contributing](@id contributing)") - println(io, "") for line in eachline(joinpath(dirname(@__DIR__), "CONTRIBUTING.md")) line = replace(line, "[LICENSE.md](LICENSE.md)" => "[License](@ref)") line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)") - println(io, "> ", line) + println(io,line) end end @info "Making documentation..." diff --git a/docs/src/man/authors.md b/docs/src/man/authors.md deleted file mode 100644 index 29082db9..00000000 --- a/docs/src/man/authors.md +++ /dev/null @@ -1,27 +0,0 @@ -# Authors - -`JustRelax.jl`'s development is coordinated by a group of *principal developers*, -who are also its main contributors and who can be contacted in case of -questions about `JustRelax.jl`. In addition, there are *contributors* who have -provided substantial additions or modifications. Together, these two groups form -"The JustRelax.jl Authors". - -## Principal Developers -* [Albert de Montserrat](https://github.com/albert-de-montserrat), - Institute for Geophysics, ETH Zurich, Switzerland -* [Pascal Aellig](https://github.com/aelligp), - Institute for Geosciences, Johannes Gutenberg University Mainz, Germany - - -## Contributors -The following people contributed major additions or modifications to `JustRelax.jl` and -are listed in alphabetical order: - -* Sidney Beeler -* Lukas Fuchs -* Boris Kaus -* Patrick Sanan -* Hendrik Ranocha -* Ludovic Räss -* Ivan Utkin -* Samuel Omlin diff --git a/docs/src/man/code_of_conduct.md b/docs/src/man/code_of_conduct.md deleted file mode 100644 index 854e4937..00000000 --- a/docs/src/man/code_of_conduct.md +++ /dev/null @@ -1,137 +0,0 @@ -```@meta -EditURL = "https://github.com/PTsolvers/JustRelax.jl/blob/main/CODE_OF_CONDUCT.md" -``` - -# [Code of Conduct](@id code-of-conduct) - -> # Contributor Covenant Code of Conduct -> -> ## Our Pledge -> -> We as members, contributors, and leaders pledge to make participation in our -> community a harassment-free experience for everyone, regardless of age, body -> size, visible or invisible disability, ethnicity, sex characteristics, gender -> identity and expression, level of experience, education, socio-economic status, -> nationality, personal appearance, race, religion, or sexual identity -> and orientation. -> -> We pledge to act and interact in ways that contribute to an open, welcoming, -> diverse, inclusive, and healthy community. -> -> ## Our Standards -> -> Examples of behavior that contributes to a positive environment for our -> community include: -> -> * Demonstrating empathy and kindness toward other people -> * Being respectful of differing opinions, viewpoints, and experiences -> * Giving and gracefully accepting constructive feedback -> * Accepting responsibility and apologizing to those affected by our mistakes, -> and learning from the experience -> * Focusing on what is best not just for us as individuals, but for the -> overall community -> -> Examples of unacceptable behavior include: -> -> * The use of sexualized language or imagery, and sexual attention or -> advances of any kind -> * Trolling, insulting or derogatory comments, and personal or political attacks -> * Public or private harassment -> * Publishing others' private information, such as a physical or email -> address, without their explicit permission -> * Other conduct which could reasonably be considered inappropriate in a -> professional setting -> -> ## Enforcement Responsibilities -> -> Community leaders are responsible for clarifying and enforcing our standards of -> acceptable behavior and will take appropriate and fair corrective action in -> response to any behavior that they deem inappropriate, threatening, offensive, -> or harmful. -> -> Community leaders 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, and will communicate reasons for moderation -> decisions when appropriate. -> -> ## Scope -> -> This Code of Conduct applies within all community spaces, and also applies when -> an individual is officially representing the community in public spaces. -> Examples of representing our community include using an official e-mail address, -> posting via an official social media account, or acting as an appointed -> representative at an online or offline event. -> -> ## Enforcement -> -> Instances of abusive, harassing, or otherwise unacceptable behavior may be -> reported to -> [Albert de Montserrat](https://github.com/albert-de-montserrat), -> [Pascal Aellig](https://github.com/aelligp), -> or any other of the principal developers responsible for enforcement listed in -> [Authors](@ref). -> All complaints will be reviewed and investigated promptly and fairly. -> -> All community leaders are obligated to respect the privacy and security of the -> reporter of any incident. -> -> ## Enforcement Guidelines -> -> Community leaders will follow these Community Impact Guidelines in determining -> the consequences for any action they deem in violation of this Code of Conduct: -> -> ### 1. Correction -> -> **Community Impact**: Use of inappropriate language or other behavior deemed -> unprofessional or unwelcome in the community. -> -> **Consequence**: A private, written warning from community leaders, providing -> clarity around the nature of the violation and an explanation of why the -> behavior was inappropriate. A public apology may be requested. -> -> ### 2. Warning -> -> **Community Impact**: A violation through a single incident or series -> of actions. -> -> **Consequence**: A warning with consequences for continued behavior. No -> interaction with the people involved, including unsolicited interaction with -> those enforcing the Code of Conduct, for a specified period of time. This -> includes avoiding interactions in community spaces as well as external channels -> like social media. Violating these terms may lead to a temporary or -> permanent ban. -> -> ### 3. Temporary Ban -> -> **Community Impact**: A serious violation of community standards, including -> sustained inappropriate behavior. -> -> **Consequence**: A temporary ban from any sort of interaction or public -> communication with the community for a specified period of time. No public or -> private interaction with the people involved, including unsolicited interaction -> with those enforcing the Code of Conduct, is allowed during this period. -> Violating these terms may lead to a permanent ban. -> -> ### 4. Permanent Ban -> -> **Community Impact**: Demonstrating a pattern of violation of community -> standards, including sustained inappropriate behavior, harassment of an -> individual, or aggression toward or disparagement of classes of individuals. -> -> **Consequence**: A permanent ban from any sort of public interaction within -> the community. -> -> ## Attribution -> -> This Code of Conduct is adapted from the [Contributor Covenant][homepage], -> version 2.0, available at -> https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -> -> Community Impact Guidelines were inspired by [Mozilla's code of conduct -> enforcement ladder](https://github.com/mozilla/diversity). -> -> [homepage]: https://www.contributor-covenant.org -> -> For answers to common questions about this code of conduct, see the FAQ at -> https://www.contributor-covenant.org/faq. Translations are available at -> https://www.contributor-covenant.org/translations. diff --git a/docs/src/man/contributing.md b/docs/src/man/contributing.md deleted file mode 100644 index 69d5831b..00000000 --- a/docs/src/man/contributing.md +++ /dev/null @@ -1,59 +0,0 @@ -```@meta -EditURL = "https://github.com/PTsolvers/JustRelax.jl/blob/main/CONTRIBUTING.md" -``` - -# [Contributing](@id contributing) - -> # Contributing -> -> `JustRelax.jl` is an open-source project and we are very happy to accept contributions -> from the community. Please feel free to open issues or submit patches (preferably -> as pull requests) any time. For planned larger contributions, it is often -> beneficial to get in contact with one of the principal developers first (see -> [Authors](@ref)). -> -> `JustRelax.jl` and its contributions are licensed under the MIT license. As a contributor, you certify that all your -> contributions are in conformance with the *Developer Certificate of Origin -> (Version 1.1)*, which is reproduced below. -> -> ## Developer Certificate of Origin (Version 1.1) -> The following text was taken from -> [https://developercertificate.org](https://developercertificate.org): -> -> Developer Certificate of Origin -> Version 1.1 -> -> Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -> 1 Letterman Drive -> Suite D4700 -> San Francisco, CA, 94129 -> -> Everyone is permitted to copy and distribute verbatim copies of this -> license document, but changing it is not allowed. -> -> -> Developer's Certificate of Origin 1.1 -> -> By making a contribution to this project, I certify that: -> -> (a) The contribution was created in whole or in part by me and I -> have the right to submit it under the open source license -> indicated in the file; or -> -> (b) The contribution is based upon previous work that, to the best -> of my knowledge, is covered under an appropriate open source -> license and I have the right under that license to submit that -> work with modifications, whether created in whole or in part -> by me, under the same open source license (unless I am -> permitted to submit under a different license), as indicated -> in the file; or -> -> (c) The contribution was provided directly to me by some other -> person who certified (a), (b) or (c) and I have not modified -> it. -> -> (d) I understand and agree that this project and the contribution -> are public and that a record of the contribution (including all -> personal information I submit with it, including my sign-off) is -> maintained indefinitely and may be redistributed consistent with -> this project or the open source license(s) involved. diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md index c9216e91..76bbfccf 100644 --- a/docs/src/man/installation.md +++ b/docs/src/man/installation.md @@ -2,7 +2,7 @@ `JustRelax.jl` is a registered package and can be added as follows: -```julia-repl +```julia using Pkg; Pkg.add("JustRelax") ``` or diff --git a/docs/src/man/license.md b/docs/src/man/license.md deleted file mode 100644 index 546b9197..00000000 --- a/docs/src/man/license.md +++ /dev/null @@ -1,27 +0,0 @@ -```@meta -EditURL = "https://github.com/PTsolvers/JustRelax.jl/blob/main/LICENSE.md" -``` - -# [License](@id license) - -> MIT License -> -> Copyright (c) 2021 Albert de Montserrat, Pascal Aellig and Authors (see [Authors](@ref)) -> -> Permission is hereby granted, free of charge, to any person obtaining a copy -> of this software and associated documentation files (the "Software"), to deal -> in the Software without restriction, including without limitation the rights -> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -> copies of the Software, and to permit persons to whom the Software is -> furnished to do so, subject to the following conditions: -> -> The above copyright notice and this permission notice shall be included in all -> copies or substantial portions of the Software. -> -> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -> SOFTWARE. diff --git a/docs/src/man/security.md b/docs/src/man/security.md deleted file mode 100644 index 1f65bf5e..00000000 --- a/docs/src/man/security.md +++ /dev/null @@ -1,30 +0,0 @@ -# Security Policy - -We take security issues seriously. We appreciate all efforts -to responsibly disclose any security issues and will make every -effort to acknowledge contributions. - - -## Supported Versions - -The current stable release following the interpretation of -[semantic versioning (SemVer)](https://julialang.github.io/Pkg.jl/dev/compatibility/#Version-specifier-format-1) -used in the Julia ecosystem is supported with security updates. - - -## Reporting a Vulnerability - -To report a security issue, please use the GitHub Security Advisory -["Report a Vulnerability"](https://github.com/PTsolvers/JustRelax.jl/security/advisories/new) -tab. - -We will send a response indicating the next steps in handling your report. -After the initial reply to your report, we will keep you informed of the -progress towards a fix and full announcement, and may ask for additional -information or guidance. - -Please report security bugs in third-party modules directly to the person -or team maintaining the module. - -Public notifications of vulnerabilities will be shared in community channels -such as Slack.