From edb9a5ebf590fb82118f492f88631aa82ef023e5 Mon Sep 17 00:00:00 2001 From: shikokuchuo <53399081+shikokuchuo@users.noreply.github.com> Date: Mon, 11 Mar 2024 21:29:28 +0000 Subject: [PATCH] quarto best practices --- _quarto.yml | 1 + contributors.qmd | 2 +- review.qmd | 4 ++-- users.qmd | 4 ++-- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/_quarto.yml b/_quarto.yml index 1b150c3..3524669 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -6,6 +6,7 @@ project: website: title: "R-releases" + site-url: "https://r-releases.github.io/" navbar: logo: "logo/logo-readme.png" left: diff --git a/contributors.qmd b/contributors.qmd index 1ad74e3..22e9b86 100644 --- a/contributors.qmd +++ b/contributors.qmd @@ -2,7 +2,7 @@ title: "Contributors" --- -The [code of conduct](conduct.html) governs all forms of participation in the R-releases project, including package contributions, issues, discussions, and the development of infrastructure. Administrators, moderators, and contributors are all subject to its terms. +The [code of conduct](conduct.qmd) governs all forms of participation in the R-releases project, including package contributions, issues, discussions, and the development of infrastructure. Administrators, moderators, and contributors are all subject to its terms. ## How to register your package with R-releases diff --git a/review.qmd b/review.qmd index aaadca4..8ea65f5 100644 --- a/review.qmd +++ b/review.qmd @@ -2,7 +2,7 @@ title: "Review Policy" --- -As the [contributors](contributors.html) page explains, updates to the R-releases package listings come from pull requests to from members of the R community. In the vast majority of cases, a GitHub app automatically merges the pull request. However, some pull requests need to be manually reviewed by an R-releases moderator. This document describes this manual review process. The goals are to: +As the [contributors](contributors.qmd) page explains, updates to the R-releases package listings come from pull requests to from members of the R community. In the vast majority of cases, a GitHub app automatically merges the pull request. However, some pull requests need to be manually reviewed by an R-releases moderator. This document describes this manual review process. The goals are to: 1. Ensure that all pull requests are reviewed using a consistent set of standards and principles that do not vary according to moderator. 2. Ensure these standards and principles are clear and transparent for the R community. @@ -37,7 +37,7 @@ The pull request is automatically flagged for manual review if: If a pull request is flagged for manual review, an R-releases moderator will read the pull request and ask questions if necessary. Although the moderator may make optional suggestions on a case-by-case basis, package reviews must be consistent, reliable, and inclusive whenever possible. The decision to close or merge the pull request must be based exclusively on the following pre-defined list of requirements: -1. Each contribution must comply with the [code of conduct](conduct.html). Examples of prohibited content include profanity, malicious behavior, security risks, copyright violations, and other conduct which could reasonably be considered inappropriate in a professional setting. All this applies to the package, the URL, any other metadata in the contribution, and the contents of the package itself. +1. Each contribution must comply with the [code of conduct](conduct.qmd). Examples of prohibited content include profanity, malicious behavior, security risks, copyright violations, and other conduct which could reasonably be considered inappropriate in a professional setting. All this applies to the package, the URL, any other metadata in the contribution, and the contents of the package itself. 1. Each contributed URL must point to an existing GitHub or GitLab repository. 1. Each text file must apply to only one package. 1. The text file name must be the name of the package. diff --git a/users.qmd b/users.qmd index 011d095..c8afd66 100644 --- a/users.qmd +++ b/users.qmd @@ -24,7 +24,7 @@ Then proceed to use `install.packages()` or `pak::pak()` etc. as you would norma Many R packages do not belong on CRAN. In particular, packages containing compiled code may require toolchains or binary downloads that fall outside of current CRAN policy. -By [contributing](contributors.html) a package to R-releases, you may conveniently install the latest released versions of these packages from a single repository location. +By [contributing](contributors.qmd) a package to R-releases, you may conveniently install the latest released versions of these packages from a single repository location. ## A guarantee of package availability @@ -35,7 +35,7 @@ A package may become unavailable on CRAN at any time due to its strict archival - Sometimes due to the archival of a dependency, and outside the maintainer's direct control. - Situations can be temporary, but may take an extended time to resolve. -By [contributing](contributors.html) a package that you rely on, you can ensure that it remains available for your critical workflows. +By [contributing](contributors.qmd) a package that you rely on, you can ensure that it remains available for your critical workflows. ## A direct distribution channel from maintainers