Skip to content

Commit

Permalink
Add website info and expand on the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rantahar committed May 28, 2024
1 parent 74483ff commit c627a8c
Showing 1 changed file with 28 additions and 10 deletions.
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,42 @@
The Nordic Research Software conference 2025 website and planning


## How planning works
You can preview the site locally using
[Zola](https://www.getzola.org/documentation/getting-started/overview/):

This is a suggestion, we can change this as we go. My idea is to follow an endorsement policy: One person makes suggests a decision. If a team member approves, it's official.
```
$ zola serve
```

1. Discussion happens in issues.
2. Make a change as a pull request.
3. Someone in the organization team reviews the pull request.
4. If they approve, they merge directly. Anyone can merge an approved PR.

## How this repository works

This is a suggestion, we can change this as we go.

My idea is to follow a single endorsement policy:
1. Anyone can make a suggestion (formally by a pull request)
2. Any conference organizer can merge (and should, if they approve)
3. Organizers should not merge their own requests.

- Discussions happen publicly in issues.
- When there is an actual task to do, this should be a new issue and should be assigned. Tasks that are not assigned to a single person tend to not be done.
- Information in this repository is official and nothing outside this repository is official.
- There are few things that cannot be public. For example communication with invited speakers, who
have not yet accepted. This information is added when possible.
- Every task should be an issue and be assigned, even if it does not result in any file changing. For example, setting up a registration form in an external service.


### The Website

The contents of the website are stored in `content/`. If you want to edit
the website, this is usually what you are looking for. The main page is
in `_index.md`.

The `static` and `templates` folders are also related to building the website.


### Documents

## Tools for organizing tasks
Other planning documents are stored in the `documents` folder. These don't
appear on the website.

- A checklist in a markdown document? Simple and easy to copy for next year.
- Project board? Quick to check issues and organize by status. Can we copy for next year?
These include for example email templates, social media messages and meeting minutes.

0 comments on commit c627a8c

Please sign in to comment.