Skip to content

Commit

Permalink
Website instructions update (#1645)
Browse files Browse the repository at this point in the history
* Small fixes to point to updated projects page

* Add information on Netlify

* Link to Netlify

* Fix mangled sentence...

* Improve another sentence

* Update howto-website.md

Co-authored-by: Eduardo Rodrigues <[email protected]>

* Update howto-website.md

Co-authored-by: Eduardo Rodrigues <[email protected]>

---------

Co-authored-by: Eduardo Rodrigues <[email protected]>
  • Loading branch information
graeme-a-stewart and eduardo-rodrigues authored Jan 31, 2025
1 parent 92ba359 commit deaf089
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
2 changes: 1 addition & 1 deletion _includes/navbar.ext
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="{{ site.baseurl }}/projects.html" id="projects_menu"><span class="glyphicon glyphicon-road"></span>&nbsp;&nbsp;Projects &amp; Support<span class="caret"></span></a>
<a class="dropdown-toggle" data-toggle="dropdown" href="{{ site.baseurl }}/projects/projects.html" id="projects_menu"><span class="glyphicon glyphicon-road"></span>&nbsp;&nbsp;Projects &amp; Support<span class="caret"></span></a>
<ul class="dropdown-menu" aria-labelledby="projects_menu">
<li><a href="{{ site.baseurl }}/projects/affiliated.html">HSF Affiliated Projects and Software</a></li>
<li><a href="{{ site.baseurl }}/projects/guidelines.html">Projects and Software Guidelines</a></li>
Expand Down
2 changes: 1 addition & 1 deletion _layouts/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2>Activities</h2>
<p>We organise many <a href="{{ '/what_are_activities.html' | relative_url
}}">activities</a> and <a href="{{ '/events.html' | relative_url
}}">events</a> and we support
<a href="{{ '/projects.html' | relative_url }}">HSF affiliated
<a href="{{ '/projects/projects.html' | relative_url }}">HSF affiliated
projects</a>. We help communication within the community through our
<a href="{{ '/forums.html' | relative_url }}">discussion forums</a>
and <a href="{{ '/technical_notes.html' | relative_url }}">technical notes</a>.
Expand Down
2 changes: 1 addition & 1 deletion get_involved.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ by joining the HSF with your software project:

* Participation in HSF [Activity Areas]({{ site.baseurl }}/what_are_activities.html)
* Participation in [HSF events and meetings]({{ site.baseurl }}/future-events.html)
* Taking advantage of the HSF by identifying your [software project]({{ site.baseurl }}/projects.html) with us
* Taking advantage of the HSF by identifying your [software project]({{ site.baseurl }}/projects/projects.html) with us and affiliating it with the HSF
* Giving input to the [HSF Steering Group]({{ site.baseurl }}/organization/team.html)
* Contributing to this website

Expand Down
16 changes: 12 additions & 4 deletions howto-website.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ If you wish (and it is recommended) you can easily set up a local instance of th
on installing and running Jekyll.
The website uses the main branch of the [hsf.github.io](https://github.com/HSF/hsf.github.io) repository.

When you make a pull request to the website repository, [Netlify](https://www.netlify.com) 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/`).

If you are not familiar with GitHub and Git, you can read our [survival kit]({{ site.baseurl }}/github-beginners.html)!

### General structure of website content files
Expand All @@ -40,10 +42,17 @@ In the *front-matter* (but not in the text itself), you need to replace any `&`

#### Markdown file

The recommended way to host a collaborative note book, e.g. for taking meeting minutes (live notes),
is to use a collaborative editing tool utilising Markdown directly. This makes it trivial to move the content into the HSF website for archiving.
The recommended way to host a collaborative notebook, e.g., for taking meeting
minutes (live notes), is to use a collaborative Markdown editor directly. This
makes it trivial to move the content into the HSF website repository for
archiving.

[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.
If you have a CERN account, one can create a Markdown file in CERNBox, using
CodiMD to edit this in a browser. One 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>, which should be
available to most people with an EduRoam login.

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


### Adding coordination meeting minutes

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.
Expand Down

0 comments on commit deaf089

Please sign in to comment.