amacocian/monica
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Rename index.md to readme.md (#3945)

Browse Source
This commit is contained in:
Alexis Saettler
2020-05-03 16:37:41 +02:00
committed by GitHub
parent 1bcf9a2a4b
commit 3391738eb6
7 changed files with 31 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/PULL_REQUEST_TEMPLATE.md
+1 -1
View File
@@ -11,7 +11,7 @@ Please read the list below. Feel free to delete this text after but we need you
### General checks ### General checks
- [ ] Make sure that the change you propose is the smallest possible. - [ ] Make sure that the change you propose is the smallest possible.
- [ ] The name of the PR should follow the [conventional commits guideline](https://github.com/monicahq/monica/blob/master/docs/contribute/index.md#conventional-commits) that the project follows. - [ ] The name of the PR should follow the [conventional commits guideline](https://github.com/monicahq/monica/blob/master/docs/contribute/readme.md#conventional-commits) that the project follows.
### Front-end changes ### Front-end changes
- [ ] If you change the UI, make sure to ask repositories administrators first about your changes by pinging djaiss or asbiin in this PR. - [ ] If you change the UI, make sure to ask repositories administrators first about your changes by pinging djaiss or asbiin in this PR.
CONTRIBUTING.md
+1 -1
View File
@@ -30,7 +30,7 @@ git checkout -b 325-add-japanese-translations
### 3. Get the test suite running ### 3. Get the test suite running
Make sure you follow the [instructions](https://github.com/monicahq/monica/blob/master/docs/contribute/index.md#testing-environment) Make sure you follow the [instructions](https://github.com/monicahq/monica/blob/master/docs/contribute/readme.md#testing-environment)
on how to setup the test suite. on how to setup the test suite.
### 4. Did you find a bug? ### 4. Did you find a bug?
docs/contribute/index.md → docs/contribute/readme.md
View File
docs/installation/index.md → docs/installation/readme.md
View File
docs/index.md → docs/readme.md
+3 -3
View File
@@ -5,12 +5,12 @@ This doc is the main source of documentation for developers working with (or con
## Table of content ## Table of content
* [Use Monica](/docs/user/index.md) * [Use Monica](/docs/user/readme.md)
* Install Monica on your server * Install Monica on your server
* [Install a new instance](/docs/installation/index.md) * [Install a new instance](/docs/installation/readme.md)
* [Maintain your server](/docs/installation/update.md) * [Maintain your server](/docs/installation/update.md)
* Contribute to Monica * Contribute to Monica
* [Contribute as a developer](/docs/contribute/index.md) * [Contribute as a developer](/docs/contribute/readme.md)
* [Help translate the application](/docs/contribute/translate.md) * [Help translate the application](/docs/contribute/translate.md)
**Specific to Monica's core contributors** **Specific to Monica's core contributors**
docs/user/index.md → docs/user/readme.md
View File
readme.md
+26 -25
View File
@@ -13,29 +13,30 @@
Monica is a great open source personal relationship management system. Monica is a great open source personal relationship management system.
* [Introduction](#introduction) - [Introduction](#introduction)
* [Purpose](#purpose) - [Purpose](#purpose)
* [Features](#features) - [Features](#features)
* [Who is it for?](#who-is-it-for) - [Who is it for?](#who-is-it-for)
* [What Monica isn't](#what-monica-isnt) - [What Monica isn't](#what-monica-isnt)
* [Where does this tool come from?](#where-does-this-tool-come-from) - [Where does this tool come from?](#where-does-this-tool-come-from)
* [Get started](#get-started) - [Get started](#get-started)
* [Requirements](#requirements) - [Requirements](#requirements)
* [Update your instance](#update-your-instance) - [Update your instance](#update-your-instance)
* [Contribute](#contribute) - [Contribute](#contribute)
* [As a community](#as-a-community) - [As a community](#as-a-community)
* [Contribute as a developer](#contribute-as-a-developer) - [Contribute as a developer](#contribute-as-a-developer)
* [Principles, vision, goals and strategy](#principles-vision-goals-and-strategy) - [Principles, vision, goals and strategy](#principles-vision-goals-and-strategy)
* [Principles](#principles) - [Principles](#principles)
* [Vision](#vision) - [Vision](#vision)
* [Goals](#goals) - [Goals](#goals)
* [Strategy](#strategy) - [Strategy](#strategy)
* [Monetization](#monetization) - [Monetization](#monetization)
* [Why Open Source?](#why-open-source) - [Why Open Source?](#why-open-source)
* [Patreon](#patreon) - [Patreon](#patreon)
* [Contact](#contact) - [Contact](#contact)
* [Thank you, open source](#thank-you-open-source) - [Team](#team)
* [License](#license) - [Thank you, open source](#thank-you-open-source)
- [License](#license)
## Introduction ## Introduction
@@ -104,7 +105,7 @@ After a few months, I decided to open source the project so it would help other
There are multiple ways of getting started with Monica. There are multiple ways of getting started with Monica.
1. You can use our hosted-version (this is the simplest way to use the product) on [https://monicahq.com](https://monicahq.com). 1. You can use our hosted-version (this is the simplest way to use the product) on [https://monicahq.com](https://monicahq.com).
1. You can install it on your server: follow installation instructions ([here](/docs/installation/index.md)). 1. You can install it on your server: follow installation instructions ([here](/docs/installation/readme.md)).
Note: while the .com version has a paid plan, there is no limitations on Monica if you install it on a server that you own. Note: while the .com version has a paid plan, there is no limitations on Monica if you install it on a server that you own.
@@ -134,7 +135,7 @@ Do you want to help? That's awesome. Here are simple things you can do.
## Contribute as a developer ## Contribute as a developer
* Read our [Contribution Guide](/CONTRIBUTING.md). * Read our [Contribution Guide](/CONTRIBUTING.md).
* Install the developer version locally so you can start contributing [instructions](/docs/contribute/index.md). * Install the developer version locally so you can start contributing [instructions](/docs/contribute/readme.md).
* Look for [issues labelled bugs](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Abug) if you are looking to have an immediate impact on the project. * Look for [issues labelled bugs](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Abug) if you are looking to have an immediate impact on the project.
* Look for [issues labelled Help wanted](https://github.com/monicahq/monica/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) These are issues that you can solve relatively easily. * Look for [issues labelled Help wanted](https://github.com/monicahq/monica/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) These are issues that you can solve relatively easily.
* Look for [issues labelled Good first issue](https://github.com/monicahq/monica/labels/good%20first%20issue) These issues are for people who want to contribute, but try to work on a small feature first. * Look for [issues labelled Good first issue](https://github.com/monicahq/monica/labels/good%20first%20issue) These issues are for people who want to contribute, but try to work on a small feature first.