diff --git a/.gitignore b/.gitignore index b462c78..7a2bf6a 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,5 @@ vignettes/*.pdf # File gen artefacts *.html *.pdf + +/.quarto/ diff --git a/README.md b/README.md index 1eeae1c..8a96eaa 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,29 @@ -# isc-proposal +# 🚧🚧🚧 UNDER CONSTRUCTION: isc-proposal 🚧🚧🚧 + +This repository is currently being revisited. +An update will be released in early September 2025. [![build-status](https://github.com/YOUR-USERNAME/YOUR-REPOSITORY/actions/workflows/publish-proposal.yaml/badge.svg)](https://github.com/YOUR-USERNAME/YOUR-REPOSITORY/actions/workflows/publish-proposal.yaml) This repository is a boilerplate repository that helps you prepare your proposal for the [R Consortium](https://www.r-consortium.org). -## Background +## Background Set up in 2015, the R Consortium is an organisation set up to help support the R Foundation, the R Community, and R users. -> The primary purpose of the R Consortium (collectively, the “Purpose”) is to: +> The primary purpose of the R Consortium (collectively, the “Purpose”) is to: > >(a) advance the worldwide promotion of and support for the R open source language and environment as the preferred language for statistical computing and graphics (the “Environment”); > ->(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment; +>(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment; > ->(c) encourage and increase user adoption, involvement with, and contribution to, the Environment; +>(c) encourage and increase user adoption, involvement with, and contribution to, the Environment; > ->(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”); +>(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”); > ->(e) support and maintain policies set by the Board; and +>(e) support and maintain policies set by the Board; and > ->(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above. +>(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above. > >In furtherance of these efforts, the R Consortium shall seek to solicit the participation of all interested parties on a fair, equitable and open basis. @@ -44,11 +47,11 @@ This is a boilerplate repository that you will need to fork, title appropriately - Use the "Use this template" button on GitHub - Create a new repository with a name to reflect your proposal -- Create a new Rstudio project from version control and use the git URL for the repo +- Create a new Positron/RStudio/IDE project from version control and use the git URL for the repo - Write an overview of the proposal instead of this boilerplate for the README -- Start completing the relevant Rmd pages of the proposal +- Start completing the relevant qmd pages of the proposal - Render `isc-proposal.qmd` to build the document locally -- Regularly commit and push the changes to github +- Regularly commit and push the changes to GitHub - Solicit feedback and contributions from others ### Automatically generate your proposal diff --git a/_quarto.yml b/_quarto.yml new file mode 100644 index 0000000..78e9c75 --- /dev/null +++ b/_quarto.yml @@ -0,0 +1,5 @@ +project: + title: "Isc-proposal" + render: + - "*.qmd" + - "!proposal/" diff --git a/isc-proposal.qmd b/isc-proposal.qmd index 87cf41f..a2d67d9 100644 --- a/isc-proposal.qmd +++ b/isc-proposal.qmd @@ -1,34 +1,39 @@ --- title: "Proposal Title" -author: +author: - name: Annie Easley orcid: 5555-5555-5555-5555 affiliations: - "Lewis Research Center, National Aeronautics and Space Administration" - + date: today date-format: iso format: html: embed-resources: true hikmah-pdf: - geometry: + geometry: - left=1.25in - right=1.25in bibliography: references.bib --- -{{< include proposal/signatories.qmd >}} +# 🚧🚧🚧 UNDER CONSTRUCTION 🚧🚧🚧 + +This repository is currently being revisited. +An update will be released in early September 2025. + +{{< include proposal/00-exec-summary.qmd >}} -{{< include proposal/problemdefinition.qmd >}} +{{< include proposal/01-signatories.qmd >}} -{{< include proposal/proposal.qmd >}} +{{< include proposal/02-problemdefinition.qmd >}} -{{< include proposal/timeline.qmd >}} +{{< include proposal/03-proposal.qmd >}} -{{< include proposal/requirements.qmd >}} +{{< include proposal/04-timeline.qmd >}} -{{< include proposal/success.qmd >}} +{{< include proposal/06-success.qmd >}} ::: refs -::: \ No newline at end of file +::: diff --git a/proposal/00-exec-summary.qmd b/proposal/00-exec-summary.qmd new file mode 100644 index 0000000..9835e66 --- /dev/null +++ b/proposal/00-exec-summary.qmd @@ -0,0 +1,6 @@ +# Executive Summary + + diff --git a/proposal/signatories.qmd b/proposal/01-signatories.qmd similarity index 82% rename from proposal/signatories.qmd rename to proposal/01-signatories.qmd index fe349f4..a9e3538 100644 --- a/proposal/signatories.qmd +++ b/proposal/01-signatories.qmd @@ -1,8 +1,8 @@ # Signatories - ## Project team - ## Contributors - ## Consulted - ``` diff --git a/proposal/03-proposal.qmd b/proposal/03-proposal.qmd new file mode 100644 index 0000000..89c1c43 --- /dev/null +++ b/proposal/03-proposal.qmd @@ -0,0 +1,50 @@ +# The proposal + + +## Overview + + +## Detail + + +### Minimum Viable Product + + + +### Architecture + + + +### Assumptions + + + +### External dependencies + + diff --git a/proposal/04-timeline.qmd b/proposal/04-timeline.qmd new file mode 100644 index 0000000..002a723 --- /dev/null +++ b/proposal/04-timeline.qmd @@ -0,0 +1,59 @@ +# Project plan + +## Start-up phase + + + +## Technical delivery + + +## Other aspects + + + +## Budget & funding plan + + + +## Budget diff --git a/proposal/success.qmd b/proposal/06-success.qmd similarity index 64% rename from proposal/success.qmd rename to proposal/06-success.qmd index 336ba5e..637abb8 100644 --- a/proposal/success.qmd +++ b/proposal/06-success.qmd @@ -1,33 +1,22 @@ # Success - ## Definition of done - ## Measuring success - ## Future work - - -## Key risks - \ No newline at end of file diff --git a/proposal/proposal.qmd b/proposal/proposal.qmd deleted file mode 100644 index 4129b6b..0000000 --- a/proposal/proposal.qmd +++ /dev/null @@ -1,24 +0,0 @@ -# The proposal - - -## Overview - - -## Detail - - -### Minimum Viable Product -### Architecture -### Assumptions diff --git a/proposal/requirements.qmd b/proposal/requirements.qmd deleted file mode 100644 index 9fd1bf4..0000000 --- a/proposal/requirements.qmd +++ /dev/null @@ -1,34 +0,0 @@ -# Requirements - - -## People - - -## Processes - - -## Tools & Tech - - -## Funding - - -## Summary - \ No newline at end of file diff --git a/proposal/timeline.qmd b/proposal/timeline.qmd deleted file mode 100644 index 4211f06..0000000 --- a/proposal/timeline.qmd +++ /dev/null @@ -1,36 +0,0 @@ -# Project plan - -## Start-up phase - - - -## Technical delivery - - -## Other aspects -