From 3391738eb6488592a4c3af4e7678e5075bc040ca Mon Sep 17 00:00:00 2001 From: Alexis Saettler Date: Sun, 3 May 2020 16:37:41 +0200 Subject: [PATCH] docs: Rename index.md to readme.md (#3945) --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- docs/contribute/{index.md => readme.md} | 0 docs/installation/{index.md => readme.md} | 0 docs/{index.md => readme.md} | 6 +-- docs/user/{index.md => readme.md} | 0 readme.md | 51 ++++++++++++----------- 7 files changed, 31 insertions(+), 30 deletions(-) rename docs/contribute/{index.md => readme.md} (100%) rename docs/installation/{index.md => readme.md} (100%) rename docs/{index.md => readme.md} (92%) rename docs/user/{index.md => readme.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4eb0ad33a..e82c8d6d2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,7 +11,7 @@ Please read the list below. Feel free to delete this text after but we need you ### General checks - [ ] 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 - [ ] If you change the UI, make sure to ask repositories administrators first about your changes by pinging djaiss or asbiin in this PR. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49a7a0018..37523127f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ git checkout -b 325-add-japanese-translations ### 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. ### 4. Did you find a bug? diff --git a/docs/contribute/index.md b/docs/contribute/readme.md similarity index 100% rename from docs/contribute/index.md rename to docs/contribute/readme.md diff --git a/docs/installation/index.md b/docs/installation/readme.md similarity index 100% rename from docs/installation/index.md rename to docs/installation/readme.md diff --git a/docs/index.md b/docs/readme.md similarity index 92% rename from docs/index.md rename to docs/readme.md index dd2eead9b..38bd59b21 100644 --- a/docs/index.md +++ b/docs/readme.md @@ -5,12 +5,12 @@ This doc is the main source of documentation for developers working with (or con ## Table of content -* [Use Monica](/docs/user/index.md) +* [Use Monica](/docs/user/readme.md) * 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) * 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) **Specific to Monica's core contributors** diff --git a/docs/user/index.md b/docs/user/readme.md similarity index 100% rename from docs/user/index.md rename to docs/user/readme.md diff --git a/readme.md b/readme.md index e94693516..db13aa6d6 100644 --- a/readme.md +++ b/readme.md @@ -13,29 +13,30 @@ Monica is a great open source personal relationship management system. -* [Introduction](#introduction) - * [Purpose](#purpose) - * [Features](#features) - * [Who is it for?](#who-is-it-for) - * [What Monica isn't](#what-monica-isnt) - * [Where does this tool come from?](#where-does-this-tool-come-from) -* [Get started](#get-started) - * [Requirements](#requirements) - * [Update your instance](#update-your-instance) -* [Contribute](#contribute) - * [As a community](#as-a-community) -* [Contribute as a developer](#contribute-as-a-developer) -* [Principles, vision, goals and strategy](#principles-vision-goals-and-strategy) - * [Principles](#principles) - * [Vision](#vision) - * [Goals](#goals) - * [Strategy](#strategy) - * [Monetization](#monetization) - * [Why Open Source?](#why-open-source) - * [Patreon](#patreon) -* [Contact](#contact) -* [Thank you, open source](#thank-you-open-source) -* [License](#license) +- [Introduction](#introduction) + - [Purpose](#purpose) + - [Features](#features) + - [Who is it for?](#who-is-it-for) + - [What Monica isn't](#what-monica-isnt) + - [Where does this tool come from?](#where-does-this-tool-come-from) +- [Get started](#get-started) + - [Requirements](#requirements) + - [Update your instance](#update-your-instance) +- [Contribute](#contribute) + - [As a community](#as-a-community) +- [Contribute as a developer](#contribute-as-a-developer) +- [Principles, vision, goals and strategy](#principles-vision-goals-and-strategy) + - [Principles](#principles) + - [Vision](#vision) + - [Goals](#goals) + - [Strategy](#strategy) + - [Monetization](#monetization) + - [Why Open Source?](#why-open-source) + - [Patreon](#patreon) +- [Contact](#contact) +- [Team](#team) +- [Thank you, open source](#thank-you-open-source) +- [License](#license) ## 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. 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. @@ -134,7 +135,7 @@ Do you want to help? That's awesome. Here are simple things you can do. ## Contribute as a developer * 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 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.