diff --git a/assets/img/computo-template-julia.png b/assets/img/computo-template-julia.png index 62367bf..c2de4bd 100644 Binary files a/assets/img/computo-template-julia.png and b/assets/img/computo-template-julia.png differ diff --git a/assets/img/computo-template-python.png b/assets/img/computo-template-python.png index 6704813..3aad151 100644 Binary files a/assets/img/computo-template-python.png and b/assets/img/computo-template-python.png differ diff --git a/assets/img/computo-template-r.png b/assets/img/computo-template-r.png index 7b50e44..2dd08ac 100644 Binary files a/assets/img/computo-template-r.png and b/assets/img/computo-template-r.png differ diff --git a/site/guidelines-authors.qmd b/site/guidelines-authors.qmd index ea3609b..92d50b9 100644 --- a/site/guidelines-authors.qmd +++ b/site/guidelines-authors.qmd @@ -23,17 +23,22 @@ This document provides a comprehensive documentation to accompany the authors du ::: {.callout-tip title="TL;DR / summary of the whole guidelines"} -- **Official templates (R, Python, Julia)**: +- **Using official templates (R, Python, Julia)**: - Create a new GitHub repository from the appropriate template - This contains document, environment and CI configuration files +- **Continuous Integration (CI)**: + - CI automatically builds and publishes HTML/PDF outputs to GitHub Pages. + - Via the github page of your repository: + - Select "GitHub Actions" under `Settings > Pages` + - Tick the box "Use your Github page Website" is the "About" section + - **Local Setup**: - Clone the repository. - - Install [Quarto](https://quarto.org/) and the [Computo Quarto extension](https://github.com/computorg/computo-quarto-extension). - - Ensure you can render the manuscript locally. + - Use `quarto render` to ensure you can build the HTML and PDF versions of the manuscript locally. - **Writing Your Contribution**: - - Main content goes in `template-computo-LANG.qmd`. + - Main content goes to `main.qmd`. - Metadata (title, authors, abstract, etc.) is set in `_quarto.yml`. - Edit using any text editor or IDE (VS Code/RStudio/Positron recommended). @@ -42,10 +47,6 @@ This document provides a comprehensive documentation to accompany the authors du - Use `renv` (R), `conda`/`requirements.txt` (Python), or `Project.toml` (Julia). - System dependencies can be installed via `setup-env-ci.sh` and `setup-render-ci.sh`. -- **Continuous Integration (CI)**: - - Uses GitHub Actions via a provided `build.yml` workflow. - - Automatically builds and publishes HTML/PDF outputs to GitHub Pages. - - **Publishing**: - Push changes to GitHub; CI will build and deploy the site. - Ensure that both PDF and HTML versions render correctly. @@ -64,9 +65,9 @@ A Computo submission is therefore a Git(Hub) repository containing: - configuration files to set up dependencies in a virtual environment; - configuration files to enable continuous integration and render the final documents. -### Template repositories {#sec-templates} +### Setup a git repository from a Computo template {#sec-git} -The [Computo](https://github.com/computorg) organization provides template repositories for [R](https://github.com/computorg/template-computo-R), [Python](https://github.com/computorg/template-computo-python), and [Julia](https://github.com/computorg/template-computo-julia) contributors. +The [Computo](https://github.com/computorg) organization provides template repositories for R, Python, Julia contributors. ::: {.grid} @@ -74,9 +75,8 @@ The [Computo](https://github.com/computorg) organization provides template repos ::: {.callout-note icon="false"} ### R -[![](/assets/img/computo-template-r.png)](https://github.com/computorg/template-computo-R/) +![](/assets/img/computo-template-r.png) - ::: ::: @@ -84,9 +84,8 @@ The [Computo](https://github.com/computorg) organization provides template repos ::: {.callout-tip icon="false"} ### Python -[![](/assets/img/computo-template-python.png)](https://github.com/computorg/template-computo-python/) +![](/assets/img/computo-template-python.png) - ::: ::: @@ -94,16 +93,14 @@ The [Computo](https://github.com/computorg) organization provides template repos ::: {.callout-important icon="false"} ### Julia -[![](/assets/img/computo-template-julia.png)](https://github.com/computorg/template-computo-julia/) +![](/assets/img/computo-template-julia.png) - ::: ::: ::: These templates provide a starting point for authors to format their contributions according to Computo's guidelines. They include the necessary files and configurations to set up a reproducible environment and continuous integration -### Setup a git repository {#sec-git} ::: {.callout-note title="Git and GitHub"} Git is a versioning tool and GitHub is an online platform owned by Microsoft which provides the service of hosting repositories with all the capabilities of versioning offered by Git. @@ -116,32 +113,61 @@ Create a new GitHub repository by navigating to the [R](https://github.com/compu ![Screenshot of the R Computo template GitHub page.](/assets/img/computo-template-screenshot.png){#fig-template width="100%"} ::: {.callout-tip title="Branches"} -When you fork a GitHub repository – whether it is a classic repository or a template – GitHub will ask if you want to include all branches (there is a box labeled *Include all branches*). You only need to fork the main branch, so you do not need to check that box. +When you create a GitHub repository from a template, GitHub will ask if you want to include all branches (there is a box labeled *Include all branches*). You do not need to check that box. ::: ::: {.callout-caution title="Public/private repository"} The paper will be automatically published online using GitHub pages. This is possible only with public repositories (which is the default behavior when you initialize your repository from this template, see @fig-clone-template). If your prefer, it is fine to keep your repository private during the writing phase. However, we ask you to set it public at the submission stage; so that the paper can be rendered and published online for the reviewers. ::: -![Forking a GitHub template.](/assets/img/clone-template.png){#fig-clone-template width="100%"} +![Using a GitHub template to create a new repository.](/assets/img/clone-template.png){#fig-clone-template width="100%"} + +### Ensure reproducibility + +You need to set up continuous integration via GitHub Actions in order to ensure reproducibility of your work and its publication as a webpage. + +#### Use Computo's built-in GitHub Action workflow + +As illustrated in @fig-deploy, under `Settings > Pages` on the webpage of your repository, select **GitHub Actions** as the source in the `Build and Deployment` section. + +![Deploy your website with GitHub Actions](/assets/img/2025-03-20-revised-github-process/depoy-github.png){#fig-deploy width="100%"} + +::: {.callout-info title="Content of `build.yml`"} +Computo has a built-in workflow to ensure reproducibility comes in the form of a YAML file describing a GitHub Action. It should have been automatically added to your repository when you cloned one of our templates. It is located under `.github/workflows/build.yml`. -::: {.callout-note title="Using Gitlab"} -You can use Gitlab for submitting to Computo. We will be giving more detailed support for this in the future. +Authors should **under no circumstances** modify this file. If you encounter a problem (such as the CI not completing successfully), please get in touch with us at . ::: +More details about Computo's workflow are found [in the corresponding FAQ entry](../blog/2025-07-31-computo-workflow/index.html). + + +#### Check the deployment {#sec-deployment} + +To check that everything is working, go to the Actions tab of your repository. You should see a workflow running (yellow wheel spinning). This might take a several minutes the first time. When this is done (green light), you can check that the template has been rendered at the URL . + +::: {.callout-tip title="Update the About section"} +Complete the description of your repository (below the "about" section) by ticking the box labeled "Use your Github page Website" (see image below). This way, anyone visiting your repo can immediately click through to see the rendered manuscript. +::: + +![Acces to HTML via GitHub page.](/assets/img/Github-page-access.png){#fig-github-page-acess width="100%" fig-align="center"} + + ### Local setup: clone, quarto, and computo extension {#sec-quarto} First, clone the repository to your local computer. In a terminal, run: ```bash # Clone the repository -git clone http://github.com//.git +git clone git@github.com//.git ``` +::: {.callout-caution title="git clone using SSH"} +Make sure you clone using the SSH version of the URL, not HTTPS. This will save you authentication headaches later on. +::: You need to have [Quarto](https://quarto.org/) and the [Computo extension](https://github.com/computorg/computo-quarto-extension) installed. -- Install Quarto: follow instructions at . -- Once Quarto is installed, open a terminal in your cloned repo folder and run: +- To install Quarto, follow instructions at . +- Once Quarto is installed, open a terminal **in the directory of the cloned repo** and run: ```bash @@ -149,15 +175,10 @@ You need to have [Quarto](https://quarto.org/) and the [Computo extension](https quarto add computorg/computo-quarto-extension ``` -::: {.callout-caution title="Multiple collaborators"} +::: {.callout-info title="Multiple collaborators"} If you are collaborating with others when writing your contributions, **each collaborator** needs to perform these same three steps (clone the repository, install Quarto and install the Computo Quarto extension). ::: -::: {.callout-tip title="Multiple programming languages"} -Quarto relies on a specific engine to compile your document. By default, that engine detects code blocks, executes them and paste the result below the code block in the rendered document. - -It is possible to use multiple languages within the same document (e.g. R and Python or Python and Julia, etc.) provided that you use the **knitr** engine. Indeed, [**knitr**](https://yihui.org/knitr/) is an R package that is able to parse code blocks from many languages. This can be achieved by specifying `engine: knitr` in your document metadata. The default engine binding that Quarto uses is detailed here: . -::: ::: {.callout-caution title="Local compilation"} Before proceeding to the next step, make sure that you are able to build your manuscript as a standard notebook on your system by running the following command in a terminal: @@ -168,9 +189,9 @@ quarto render ``` ::: -### Files and metadata {#sec-files-metadata} +### Writing your contribution {#sec-files-metadata} -There are mainly two files you are expected to modify in your repository for writing your contribution: `template-computo-LANG.qmd` (where LANG is to be replaced with either R, Python or Julia) and `_quarto.yml`. While the first can be renamed (e.g, `submission-YYYYMM-firstAuthor-keyword.qmd`), the second must remain `_quarto.yml` as it contains metadata about your contribution shared between project's files. +There are mainly two files you are expected to modify in your repository for writing your contribution: `main.qmd` and `_quarto.yml`. These files should not be renamed. ::: {.callout-tip} ## Editing your project @@ -179,17 +200,17 @@ You can edit your project using any text editor, but we recommend using an IDE s #### Metadata of your contribution -All yaml metadata should preferably be placed in the `_quarto.yml` file. To customise title, authors, date, abstract and so on, you should modify `_quarto.yml` which by default looks like this: +The metadata of your contribution (title, authors, affiliation, date, abstract) should be placed in the `_quarto.yml` file, which by default looks like this: ```yml project: type: default render: - - template-computo-LANG.qmd + - main.qmd - README.qmd title: "Template for contribution to Computo" -subtitle: "Example dedicated to `LANG` users" +subtitle: "Example dedicated to `R` users" author: - name: Jane Doe corresponding: true @@ -205,34 +226,38 @@ author: url: https://johndoe.someplace.themoon.org orcid: 0000-0000-0000-0000 affiliations: - - name: Name of Afficiliation two + - name: Name of Affiliation two department: Computer Science url: https://someplace.themoon.org date: last-modified date-modified: last-modified -description: | - This document provides a template based on the [`quarto`](https://quarto.org/) system for contributions to Computo, using the [`quarto journal extension`](https://github.com/computorg/computo-quarto-extension), the knitr kernel (R user) and [`renv`](https://rstudio.github.io/renv/articles/renv.html) to set-up the dependencies. abstract: >+ - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur posuere vestibulum facilisis. Aenean pretium orci augue, quis lobortis libero accumsan eu. Nam mollis lorem sit amet pellentesque ullamcorper. Curabitur lobortis libero eget malesuada vestibulum. Nam nec nibh massa. Pellentesque porttitor cursus tellus. Mauris urna erat, rhoncus sed faucibus sit amet, venenatis eu ipsum. + Template for preparing a submission to Computo, using the [quarto journal extension](https://github.com/computorg/computo-quarto-extension), the knitr kernel (R user) and [renv](https://rstudio.github.io/renv/articles/renv.html) to set up the dependencies. + + For a detailed, step-by-step guide on preparing your article, setting up the continuous integration and submitting it to Computo, please consult the [guidelines for authors](https://computo-journal.org/site/guidelines-authors.html). keywords: [key1, key2, key3] bibliography: references.bib github-user: computorg repo: "template-computo-r" -draft: true # set to false once the build is running -published: false # will be set to true once accepted +status: "submitted" +citation: + type: article-journal + container-title: "Computo" + issn: "2824-7795" + doi: "10.5072/computo.0000" # placeholder DOI (10.5072 is the official DOI test prefix), replace once assigned license: CC-BY-4.0 format: computo-html: default computo-pdf: default ``` -You can customize most of the entries in that file except `project:`, `published:`, `draft:`, `license:` and `format:`. If your contribution is accepted for publication, the associate editors will modify parts of this file accordingly. +You can customize most of the entries in that file except `status:`, `license:` and `format:`. These entries will be edited by the associate editors if your contribution is accepted for publication. #### Main content of your contribution -The main content of your contribution must be written in the `template-computo-LANG.qmd` file (see formatting suggestion therein). To compile your contribution, run `quarto render` anytime needed. +The main content of your contribution must be written in the `main.qmd` file (see formatting suggestion therein). To compile your contribution, run `quarto render`. -We also provide a `README.qmd` file as part of the project. This file uses shortcodes to extract metadata from `_quarto.yml` and generate a `README.md` that will be displayed on the main page of your GitHub repository. The `README.md` file is rendered automatically when you run `quarto render` at the root of your repository. You may modify the `README.qmd` file if you wish, at your own risk. If your submission is accepted, it will be standardized by the Computo team. +We also provide a `README.qmd` file as part of the project, which is used by the Computo team to generate a `README.md` for accepted papers. Please do not modify this file. ### Setup dependencies {#sec-dependencies} @@ -256,29 +281,7 @@ The next step is to inform Computo of the other packages, tools and environment {{< include _handle_dependencies_julia.qmd >}} ::: -### Ensure reproducibility {#sec-reproducibility} - -Now that you have written your contribution in the correct template and set up its dependencies, you need to set up continuous integration via GitHub Actions in order to ensure reproducibility of your work and its publication as a webpage. - -#### Use Computo's built-in GitHub Action workflow - -Computo has a built-in workflow for just that purpose which comes in the form of a YAML file describing a GitHub Action. It should have been automatically added to your repository when you cloned one of our templates. It is located under `.github/workflows/build.yml`. - -::: {.callout-important title="Content of `build.yml`"} -Authors should **under no circumstances** modify this file. If you encounter a problem (such as the CI not completing successfully), please get in touch with us at . -::: - -Next, as illustrated in @fig-deploy, under `Settings > Pages` on the webpage of your repository, select **GitHub Actions** as the source for building and deploying your website. - -![Deploy your website with GitHub Actions](/assets/img/2025-03-20-revised-github-process/depoy-github.png){#fig-deploy width="100%"} - -Authors can find more details about Computo's workflow [in the corresponding FAQ entry](../blog/2025-07-31-computo-workflow/index.html). - -::: {.callout-note title="Compatibility with old reproducibility system"} -You can safely delete the `gh-pages` branch if you have one, as we don't need anymore to push the HTML files to the site. -::: - -#### Handle external *system* dependencies +### Handle external *system* dependencies {#sec-system-dep} While R, Python, or Julia package dependencies should be managed using the appropriate environment tools, your project may also require external *system* dependencies (such as libraries or command-line tools). These must be installed on the GitHub runner during environment setup or rendering. To handle this, add and customize two scripts at the root of your repository: @@ -306,19 +309,11 @@ Remember that the GitHub runner uses Linux Ubuntu and therefore software install Once you have finished part of your writing and confirmed that the document builds successfully locally, you can push your changes to GitHub as you would with any Git project. If everything is set up correctly, the continuous integration workflow will automatically build and publish the HTML and PDF versions online. -::: {.callout-caution} -## Ignored files -Make sure to check and update the `.gitignore` file in your repository. In particular, if you changed the name of some files in the repository (like the main `.qmd` file), make propagate this change to the `.gitignore` file in order to avoid pushing binary files to the repository (such as the PDF file). -::: - ### Submit your manuscript {#sec-submitting} Once you are satisfied with your manuscript, you can submit it for review. To do so, upload the generated PDF to the [OpenReview](https://openreview.net/group?id=Computo) platform and indicate the corresponding Git repository. This will initiate both the scientific and reproducibility review processes. -Please also ensure that the HTML version of your manuscript is publicly accessible for reviewers on the GitHub Pages site associated with your repository. To do so, complete the description of your repository (below the "about" section) by ticking the box labeled "Use your Github page Website" (see image below). - -![Acces to HTML via GitHub page.](/assets/img/Github-page-access.png){#fig-github-page-acess width="100%" fig-align="center"} - +Please also ensure that the HTML version of your manuscript is publicly accessible for reviewers on the GitHub Pages site associated with your repository, as explained in @sec-deployment. For more details about the review process, see the [guidelines for reviewers](/site/guidelines-reviewers.qmd). @@ -340,7 +335,7 @@ A new page opens where you need to select *Specify an organization or username* ### Mock contributions -In addition to the template repositories that can serve as example papers (see @sec-templates), we provide more in-depth illustrations of the expected content and available features through mock contributions consisting of a complete reworking of the famous t-SNE article. +In addition to the template repositories that can serve as example papers (see @sec-git), we provide more in-depth illustrations of the expected content and available features through mock contributions consisting of a complete reworking of the famous t-SNE article. ::: {#examples} :::