Skip to content

Commit deaf089

Browse files
Website instructions update (#1645)
* 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]>
1 parent 92ba359 commit deaf089

File tree

4 files changed

+15
-7
lines changed

4 files changed

+15
-7
lines changed

_includes/navbar.ext

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
</ul>
5555
</li>
5656
<li class="dropdown">
57-
<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>
57+
<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>
5858
<ul class="dropdown-menu" aria-labelledby="projects_menu">
5959
<li><a href="{{ site.baseurl }}/projects/affiliated.html">HSF Affiliated Projects and Software</a></li>
6060
<li><a href="{{ site.baseurl }}/projects/guidelines.html">Projects and Software Guidelines</a></li>

_layouts/main.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2>Activities</h2>
8787
<p>We organise many <a href="{{ '/what_are_activities.html' | relative_url
8888
}}">activities</a> and <a href="{{ '/events.html' | relative_url
8989
}}">events</a> and we support
90-
<a href="{{ '/projects.html' | relative_url }}">HSF affiliated
90+
<a href="{{ '/projects/projects.html' | relative_url }}">HSF affiliated
9191
projects</a>. We help communication within the community through our
9292
<a href="{{ '/forums.html' | relative_url }}">discussion forums</a>
9393
and <a href="{{ '/technical_notes.html' | relative_url }}">technical notes</a>.

get_involved.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ by joining the HSF with your software project:
2424

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

howto-website.md

Lines changed: 12 additions & 4 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](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/`).
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
@@ -40,10 +42,17 @@ In the *front-matter* (but not in the text itself), you need to replace any `&`
4042

4143
#### Markdown file
4244

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

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.
50+
If you have a CERN account, one can create a Markdown file in CERNBox, using
51+
CodiMD to edit this in a browser. One can then define a public link to the
52+
document (similar to Google Docs public links) to allow those without a CERN
53+
account to edit the file. Similarly, the Helmholtz Association has a web based
54+
Markdown instance that can be used at <https://notes.desy.de>, which should be
55+
available to most people with an EduRoam login.
4756

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

57-
5866
### Adding coordination meeting minutes
5967

6068
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)