You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/guidelines-authors.qmd
+16-65Lines changed: 16 additions & 65 deletions
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,13 @@ format:
8
8
number-sections: true
9
9
fig-align: "center"
10
10
page-layout: article
11
-
bibliography: ../publications/published.bib
12
11
lightbox: true
12
+
listing:
13
+
- id: examples
14
+
template: publications.ejs
15
+
contents: mock-papers.yml
16
+
sort: date desc
17
+
type: table
13
18
---
14
19
15
20
## Introduction
@@ -278,7 +283,7 @@ Next, as illustrated in @fig-deploy, under `Settings > Pages` on the webpage of
278
283
279
284
{#fig-deploy width="100%"}
280
285
281
-
Authors can find more details about Computo's workflow in @sec-workflow.
286
+
Authors can find more details about Computo's workflow [in the corresponding FAQ entry](../blog/2025-07-31-computo-workflow/index.html).
282
287
283
288
::: {.callout-note title="Compatibility with old reproducibility system"}
284
289
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.
@@ -337,38 +342,24 @@ A new page opens where you need to select *Specify an organization or username*
337
342
338
343
{#fig-transfer-ownership-3 width="100%" fig-align="center"}
339
344
340
-
## Example papers {#sec-examples}
345
+
## Advanced examples {#sec-examples}
341
346
342
-
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.
347
+
### Mock contributions
343
348
344
-
::: {.grid}
345
-
346
-
::: {.g-col-6}
347
-
::: {.callout-note icon="false"}
348
-
### R
349
+
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.
For other advanced examples, do not hesitate to explore the source code of any [paper already published in Computo](https://computo-journal.org/site/publications.html) to see how the template is used in practice. In particular, reproducing an existing paper published in Computo can be easily done [as detailed in the FAQ](../blog/2025-07-31-reproduce-paper/index.html).
366
358
:::
367
359
368
360
:::{.callout-tip}
369
-
## Accessing paper source
370
-
371
-
For other advanced examples, do not hesitate to explore the source code of any [paper already published in Computo](https://computo-journal.org/site/publications.html) to see how the template is used in practice. You can also access the source code of the example papers mentioned above by clicking on the `</> Source` button in the upper-right corner of the page as illustrated in @fig-template-source.
361
+
## Accessing source code
362
+
You can also access the source code of the example papers mentioned above by clicking on the `</> Source` button in the upper-right corner of the page as illustrated in @fig-template-source.
372
363
:::
373
364
374
365
{#fig-template-source width="100%"}
@@ -377,46 +368,6 @@ The source code of the page then displays as shown in @fig-template-source-displ
377
368
378
369
{#fig-template-source-display width="100%"}
379
370
380
-
## Computo's publication workflow {#sec-workflow}
381
-
382
-
The Computo workflows provide a streamlined publishing pipeline for authors to submit and render Quarto articles directly on GitHub Pages without requiring technical expertise.
As illustrated in @fig-workflow, the publication process consists of two main phases:
389
-
390
-
1. **Environment Setup and Caching** (`global-env.yml`)
391
-
- Detects and installs required dependencies (Python, R)
392
-
- Caches the environment for faster subsequent runs
393
-
- Customizable via `setup-env-ci.sh`
394
-
2. **Rendering and Deployment** (`publish-render.yml`)
395
-
- Renders Quarto documents to HTML
396
-
- Publish the output to GitHub Pages
397
-
- Customizable via `setup-render-ci.sh`
398
-
399
-
Authors only need to reference the main workflow file (`build.yml`) in their repository, which orchestrates these processes.
400
-
401
-
### Key Benefits
402
-
403
-
- **Simplified Process**: Authors need minimal GitHub Actions knowledge
404
-
- **Optimized Performance**: Environment caching for faster builds
405
-
- **Customization Points**: Two script entry points for custom configurations
406
-
- **Automated Deployment**: Direct publishing to GitHub Pages
407
-
408
-
Authors simply use the `build.yml` workflow in their repository to trigger the complete process from environment setup to final publication.
409
-
410
-
### Reproducing an existing paper published in Computo
411
-
412
-
Our publication workflow makes it very easy for anyone to reproduce a given paper. Consider for instance the paper <https://doi.org/10.57750/sfxn-1t05> associated with the Github repository [published-202412-giorgi-efficient][https://github.com/computorg/published-202412-giorgi-efficient]. You first need to clone the repository. Then you need to install Quarto and the Computo Quarto extension in the `published-202412-giorgi-efficient` folder that the cloning step made. Finally, you can render the document. In summary, you do that with the following commands:
0 commit comments