Skip to content

Commit 482a801

Browse files
docs(README): link contribution guidelines
- move developer info to CONTRIBUTING - move miro design up in the README
1 parent 126d2c1 commit 482a801

File tree

2 files changed

+15
-25
lines changed

2 files changed

+15
-25
lines changed

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ chore(deps-dev): bump eslint-plugin-unused-imports from 3.1.0 to 3.2.0 in /cms
1818

1919
The setup for this project consists of three main parts: the website (web), the content management system (cms), and the database (db). The website is built with Next.js, while the CMS is Strapi, and MySQL 8 is used for the database. You'll need Node.js with npm for both web and cms. If you want to start the applications without docker please refer to the specific Node.js versions indicated in the `.nvmrc` file or the `engines` field in `package.json`. However, we use Docker to facilitate the development process. Both the website and CMS have their own Dockerfile. All components are managed together in a docker-compose file.
2020

21+
For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/
22+
2123
### Prerequisites
2224

2325
- Docker and Docker Compose

README.md

+13-25
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
21
# Overview
32

4-
This is the relaunch of the new www.vim.org website. We have found a small team that will take on the
3+
This is the relaunch of the www.vim.org website. We have found a small team that will take on the
54
beautiful task of rebuilding the website with current design and new concepts.
65

76
The new development should not take place behind closed doors, we want to
@@ -11,6 +10,13 @@ Soon there will be a test system where you can follow the current status success
1110

1211
Of course, we will involve you, the community, in the design by collecting ideas and feedback.
1312

13+
Please read the [contribution guidelines](CONTRIBUTING.md) if you want to help out.
14+
15+
### New Design
16+
17+
The link below leads to a publicly accessible Miro board that contains a first draft of the new website design:
18+
https://miro.com/app/board/uXjVKobQViM=/?share_link_id=158721849826
19+
1420
# Build
1521

1622
Prerequisites
@@ -20,33 +26,16 @@ Prerequisites
2026

2127
### Getting started
2228

23-
Run the application locally with these make commands.
29+
Run the application locally with the following commands.
2430

2531
```sh
2632
# start prebuilt containers
2733
make start
28-
29-
# or start containers for local development
30-
make dev
3134
```
3235

3336
This will setup default configuration (including dummy secrets),
3437
install npm dependencies and start the application using docker on port `3000`.
3538

36-
### Build locally
37-
38-
The following steps must be carried out:
39-
1. Copy contents of `.env.example` files on `root`, `root/cms` and `root/web` into `.env` file
40-
2. Install npm dependencies with `npm install` in the `root`, `root/cms` and `root/web` folder.
41-
3. Startup: `docker compose up`
42-
43-
For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/
44-
45-
# New Design
46-
47-
The link below leads to a publicly accessible Miro board that contains a first draft of the new website design:
48-
https://miro.com/app/board/uXjVKobQViM=/?share_link_id=158721849826
49-
5039
# Requirements
5140

5241
Add your requirements here:
@@ -66,21 +55,20 @@ Add your requirements here:
6655
* The hashing of the user passwords is to be migrated to a hashing procedure that corresponds to the state of the art.
6756
* The frontend/backend stack shall:
6857
- should be maintainable and expandable in the future with reasonable effort
69-
- be opensource based
58+
- be Open Source based
7059
- the components used should be vital
7160
- shall be efficient with server resources
7261

7362

7463
# Idea collection
7564

76-
This is a unfinished and unstructed list of ideas:
65+
This is a unfinished and instructed list of ideas:
7766

7867
- Tutorial section
7968
- Vim tips revival
8069
- The vim tricks
81-
- My personal ".vimrc", with annotations about motivations
82-
- Blog posts and annountements for the maintainers and artive editors
70+
- My personal `.vimrc`, with annotations about motivations
71+
- Blog posts and announcements for the maintainers and active editors
8372
- Link resource section
84-
- "How to contribute" section
8573
- Vim distributions for the various platforms
8674

0 commit comments

Comments
 (0)