Skip to content

Commit 3666c9d

Browse files
committed
Update README.md
- move slack stuff from the wiki to this file - move the member page how-to to the wiki
1 parent d4bcaf0 commit 3666c9d

File tree

1 file changed

+14
-50
lines changed

1 file changed

+14
-50
lines changed

README.md

+14-50
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,20 @@
1-
# SwissBIAS.github.io
2-
Website for the SwissBIAS network: Swiss BioImage Analysts' network
3-
See also the associated [wiki](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki)
1+
# [swissbias.org](https://www.swissbias.ch)
2+
Website for the SwissBIAS network: Swiss BioImage Analysts' network.
43

5-
## How to contribute
6-
We decided to keep some control over what’s published by merging Pull Requests. So ***please fork, modify, PR*** and then we’ll merge your changes. Please see this [guide to create a Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). \
7-
If you would prefer to generate a dummy website to make sure it looks exactly as you want before pushing it, you can create your locally served website. To do so, follow the instructions provided for the _imagej.github.io_ pages about [Jekyll and Git](https://github.com/imagej/imagej.github.io/blob/main/_pages/editing/advanced.md).
8-
9-
## Quickstart: Adding and editing member information
10-
Each member have their own markdown file, stored in the `/_members` directory.
11-
It consists of a YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) (between the triple-dashed lines) and document body written in Github flavored [markdown](https://guides.github.com/features/mastering-markdown/). Bellow is an example, for the file `simon.noerrelykke.md`:
12-
13-
```markdown
14-
---
15-
first_name: Simon F.
16-
last_name: Noerrelykke
17-
short_name: simon
18-
city: Zurich
19-
affiliation: ETH Zurich
20-
position: Image Analyst
21-
tags: [matlab, fiji]
22-
---
23-
24-
Simon works at ETH Zurich.\\
25-
He heads [IDA](http://let-your-data-speak.com/) - the Image and Data Analysis group inside of ScopeM.
26-
```
4+
> To keep this document compact, the bulk of the documentation is on our [wiki](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki).
275
28-
To create a new member file, copy an existing file, rename as `firstName.lastName.md`, change all text that needs changing, and save it in `/_members` (commit it).
6+
## Connect with the community
7+
The community uses [slack](https://app.slack.com) for the day-to-day chat. To join, please send us an [email](mailto:[email protected]?subject=Request%20to%20join). Instructions will follow in the reply to your request.
298

30-
> Front Matter conventions:
31-
> * The `city` attribute should only be used for Swiss cities and left empty otherwise. To add a new city not yet present on [the map](https://swissbias.github.io/members/), check out [detailed documentation](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki/How-to-add-yourself-to-the-webpage#the-city-attribute)
32-
> * The `affiliation` attribute can hold only one institution/company. Use its main name and put the detailed description in the document body.
9+
If you're not familiar with Slack we recommend you to have a look at this [quick start guide](https://slack.com/help/articles/360059928654-How-to-use-Slack--your-quick-start-guide).
3310

34-
**Small edits** can be done directly in your browser in GitHub.
35-
**Larger changes** to structure must be done locally, then pushed to GitHub (see the [above section](#how-to-contribute).
11+
### Recommendations:
12+
- Use the desktop version (instead of the web browser version).
13+
- You can join the channels of interest using the `+` icon in front of **Channels**.
14+
- If you create a channel, please announce it on `#general` using the template message:
15+
> Dear @channel, a new channel has been created to discuss #channel-name
3616
37-
That is it!
38-
The new member will automatically be added to the list of all members and have their own page with the text they provided, e.g. `https://www.swissbias.ch/members/simon.noerrelykke`.
39-
40-
## Adding pages
41-
To add a webpage, create it as markdown or html and place it in `_pages` (become and editor or create a pull request for this).
42-
You can link to it from another page or add it to the navigation menu (be conservative -- navigation bars quickly become crowded).
43-
44-
## Navigation bars
45-
There are several possible navigation bars, read the documentation for whatever Jekyll theme we are using, e.g. [minimal-mistakes](https://github.com/mmistakes/minimal-mistakes).
46-
Pages are added to the top bar by editing the file `navigation.yml` in the `/_data` folder.
47-
48-
# The configuration file
49-
Most configuration takes place in the `_config.yml` file at root level.
50-
Be careful if editing this!
17+
## How to contribute
18+
The documentation about the architecture of the webpage and a number of how-to's can be found on [this page](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki/How-to-contribute).
5119

52-
# Layouts
53-
Instead of specifying and formatting the looks of each individual page, templates are applied:
54-
In the `/_layouts` folder, many are available, often inheriting features from each other, and you can add more if you want.
55-
The layout applied to a given file/page is either specified in the YAML frontmatter or applies to all files in a given folder as specified in the configuration file `_config.yml`.
56-
For example, all files in the folders `/_pages` and `/_members` have the `single` layout applied to them.
20+
SwissBIAS members, that want to create/edit their `_member/[first.last].md` page, can jump to [this section](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki/How-to-contribute#adding-a-member-page).

0 commit comments

Comments
 (0)