diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index a2e69b8..e1b12e9 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -43,7 +43,7 @@ jobs: strategy: fail-fast: false matrix: - language: ['javascript-typescript', 'go'] + language: ['javascript-typescript'] # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' # Use `c-cpp` to analyze code written in C, C++ or both # Use 'java-kotlin' to analyze code written in Java, Kotlin or both diff --git a/README.md b/README.md index 3c89680..38dba78 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,113 @@ BioUno website. +## Building + +You must install Hugo to build the project locally. The +Hugo [website][hugo] contains information to install it on +Linux, macOS, and Windows. Hugo is written in Go, so you +will have to install Go as well — refer to Hugo website. + +Go into the directory where you cloned this repository, and +run Hugo to build or to serve the website locally. + +```console +# This will build +$ hugo + +# This will serve and watch for changes +$ hugo server --watch +``` + +If you want to have a more verbose output, you can use this +variation. + +```console +$ hugo server --navigateToChanged --buildDrafts --buildFuture --watch --verbose +``` + +And if you want to make sure that you are not having problems +with caching, you can remove the `public` directory, which is +used by Hugo to build the blog. + +```console +$ rm -rf public && hugo server --navigateToChanged --buildDrafts --buildFuture --watch --verbose +``` + +### Creating a new page + +If you create a new section (e.g. `faq`), you will have to create +a directory with a `_index.md` file. See existing directories like +`./content/blog/` or `./content/tutorials/` for example. + +To add a page to an existing section, the simplest option is to just +copy an existing page. You can also create an empty Markdown page +(e.g. `./content/faq/new-file.md`). + +If you are building the site with `--watch`, you should be able to +navigate to that page already at . + +Existing pages (and posts) contain a YAML header, called “front matter”. +You can copy an existing header as example. + +```markdown +--- +title: Give it some nice title +--- + +This is markdown. + +

Or HTML...

+``` + +### Creating a new post + +Blog posts are created in the directory `/content/blog/`. The +existing posts were migrated from Jekyll, so we need to follow +the existing pattern for consistency. + +- `2020-01-20-url-friendly-title.md` + +In the example above, `2020-01-20` is the post date. This is not +really used, but it can be added just for the sake of keeping up +with the existing pattern. + +The `url-friendly-title` is the part that will be used in the URL, +so choose one that is unique and simple, with dashes or underscores. + +Before writing the post content, the front matter YAML header +needs to be added, as in the example below. + +```markdown +--- +title: "Advanced Cross-Project Linking of Jenkins Artifacts" +description: "Linking Data-Source Builds and their Metadata" +tags: [Jenkins, workflow, data-sciences, analysis, bioinformatics, metadata] +author: Ioannis K. Moutsatsos +date: 2020-02-02 +--- + +Any markdown **content** here. Like in GitHub. + +

Or some HTML.

+``` + +The front matter header above defines a title, that appears in +the web page generated. The description is used in the blog +listing as a summary for the post (when visiting the URL `/blog/`). + +The tags are used to classify the post. Fill in the author name +and the date. The date will be used to produce the URL slug +name (`/2020/02/02/advanced...` in the example above). + +Preview your post locally — building and serving locally, as +per instructions above — and commit to a pull request or to +a branch like `master` once you are done. In a few seconds the +GitHub Actions pipeline will run, and if it succeeds the site +will be updated with your post. + +GitHub Actions builds take seconds to one or minutes. + ## Contributing All contributions are welcome! Send us your issues, pull requests or suggestions. @@ -9,3 +116,5 @@ All contributions are welcome! Send us your issues, pull requests or suggestions ## License [MIT](http://opensource.org/licenses/MIT) + +[hugo]: https://gohugo.io/ diff --git a/content/documentation/_index.md b/content/documentation/_index.md index 56376a2..17f8993 100644 --- a/content/documentation/_index.md +++ b/content/documentation/_index.md @@ -1,5 +1,4 @@ --- -layout: single title: Documentation weight: 200 --- diff --git a/content/projects/jenkins-plugins.md b/content/projects/jenkins-plugins.md index 6ec6e3b..72e3025 100644 --- a/content/projects/jenkins-plugins.md +++ b/content/projects/jenkins-plugins.md @@ -1,5 +1,4 @@ --- -layout: single title: Jenkins Plug-ins aliases: - /jenkins-plugins.html diff --git a/content/projects/jenkins-update-site.md b/content/projects/jenkins-update-site.md index 563c940..a94ace5 100644 --- a/content/projects/jenkins-update-site.md +++ b/content/projects/jenkins-update-site.md @@ -1,5 +1,4 @@ --- -layout: single title: Jenkins Update Site aliases: - /jenkins-update-site.html diff --git a/content/tutorials/active-choices-plugin/_index.md b/content/tutorials/active-choices-plugin/_index.md index 55f1e10..8fee601 100644 --- a/content/tutorials/active-choices-plugin/_index.md +++ b/content/tutorials/active-choices-plugin/_index.md @@ -1,5 +1,4 @@ --- -layout: single title: Active Choices Plugin Tutorials url: /tutorials/active-choices-plugin/ --- diff --git a/content/tutorials/misc/running-structure-in-parallel-using-jenkins-slaves.md b/content/tutorials/misc/running-structure-in-parallel-using-jenkins-slaves.md index deef41e..efd652b 100644 --- a/content/tutorials/misc/running-structure-in-parallel-using-jenkins-slaves.md +++ b/content/tutorials/misc/running-structure-in-parallel-using-jenkins-slaves.md @@ -1,5 +1,4 @@ --- -layout: single title: Running Structure in parallel using Jenkins slaves --- diff --git a/content/tutorials/misc/using-the-figshare-plugin.md b/content/tutorials/misc/using-the-figshare-plugin.md index c8f0b67..30875ae 100644 --- a/content/tutorials/misc/using-the-figshare-plugin.md +++ b/content/tutorials/misc/using-the-figshare-plugin.md @@ -1,5 +1,4 @@ --- -layout: single title: Using the figshare Plug-in --- diff --git a/content/tutorials/r-plugin/tutorial01-jenkins-rscript.md b/content/tutorials/r-plugin/tutorial01-jenkins-rscript.md index 87015b8..c78e77b 100644 --- a/content/tutorials/r-plugin/tutorial01-jenkins-rscript.md +++ b/content/tutorials/r-plugin/tutorial01-jenkins-rscript.md @@ -1,5 +1,4 @@ --- -layout: single title: Tutorial 1 - Integrating Jenkins with R-script --- diff --git a/content/tutorials/r-plugin/using-the-jenkins-r-plugin.md b/content/tutorials/r-plugin/using-the-jenkins-r-plugin.md index 88374f0..c608cc3 100644 --- a/content/tutorials/r-plugin/using-the-jenkins-r-plugin.md +++ b/content/tutorials/r-plugin/using-the-jenkins-r-plugin.md @@ -1,5 +1,4 @@ --- -layout: single title: Using the Jenkins R Plug-in ---