Skip to content

Commit 7de6d30

Browse files
Add information on Netlify
1 parent 098ef84 commit 7de6d30

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

howto-website.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ If you wish (and it is recommended) you can easily set up a local instance of th
2626
on installing and running Jekyll.
2727
The website uses the main branch of the [hsf.github.io](https://github.com/HSF/hsf.github.io) repository.
2828

29+
When you make a pull request to the website repository, Netlify will build a preview version of the website with your PR. This will allow you to double check the update looks the way that you intended (check for the `Deploy Preview` URL in the PR; it will be something like `https://deploy-preview-1644--earnest-hotteok-b1e1bf.netlify.app/`).
30+
2931
If you are not familiar with GitHub and Git, you can read our [survival kit]({{ site.baseurl }}/github-beginners.html)!
3032

3133
### General structure of website content files
@@ -43,7 +45,7 @@ In the *front-matter* (but not in the text itself), you need to replace any `&`
4345
The recommended way to host a collaborative note book, e.g. for taking meeting minutes (live notes),
4446
is to use a collaborative editing tool utilising Markdown directly. This makes it trivial to move the content into the HSF website for archiving.
4547

46-
[CodiMD](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation) is the suggested choice as it has been designed for collaboraitve editing of Markdown files. Unfortunately, the [Hackmd](https://hackmd.io) free service is now restricted to 4 editors. Another possibility, if you have a CERN account, is to use CERNBox which makes CodiMD available to edit Markdown files: you can then define a public link to the document (similar to Google Docs public links) to allow those without a CERN account to edit the file.
48+
If you have a CERN account, is to use CERNBox which makes CodiMD available to edit Markdown files: you can then define a public link to the document (similar to Google Docs public links) to allow those without a CERN account to edit the file. Similarly, the Helmholtz Association has a web based markdown instance that can be used at <https://notes.desy.de>.
4749

4850
We find that *recycling* the same document for a series of meetings is extremely useful
4951
as the *live notes* link can be copied and cloned from one meeting to the next.
@@ -54,7 +56,6 @@ Google Docs can also be used for shared notebooks, but in this case there is a n
5456
the document to Markdown before it can be added to the website. This is less convenient, but
5557
we have [documentation]({{ site.baseurl }}/jekyll-beginners.html) on how to do it.
5658

57-
5859
### Adding coordination meeting minutes
5960

6061
HSF Coordination minutes are produced using the live notes approach described above. The content of the live notes are preformatted to be suitable for direct injection into Jekyll, after minimal edits described in the [running-meetings]({{ site.baseurl }}/organization/running-meetings.html) page. The minutes file must be placed into Jekyll `organization/_posts` directory.

0 commit comments

Comments
 (0)