📝(doc) minor README.md formatting and wording enhancements
See https://github.com/suitenumerique/docs/issues/622
This commit is contained in:
committed by
Anthony LC
parent
296dbb7957
commit
8281c6159b
30
README.md
30
README.md
@@ -23,6 +23,7 @@ Welcome to Docs! The open source document editor where your notes can become kno
|
|||||||
<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
|
<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
|
||||||
|
|
||||||
## Why use Docs ❓
|
## Why use Docs ❓
|
||||||
|
|
||||||
Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
|
Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
|
||||||
|
|
||||||
### Write
|
### Write
|
||||||
@@ -33,23 +34,31 @@ Docs is a collaborative text editor designed to address common challenges in kno
|
|||||||
* ✨ Save time thanks to our AI actions (generate, sum up, correct, translate)
|
* ✨ Save time thanks to our AI actions (generate, sum up, correct, translate)
|
||||||
|
|
||||||
### Collaborate
|
### Collaborate
|
||||||
* 🤝 Collaborate in realtime with your team mates
|
* 🤝 Collaborate with your team in real time
|
||||||
* 🔒 Granular access control to keep your information secure and shared with the right people
|
* 🔒 Granular access control to ensure your information is secure and only shared with the right people
|
||||||
* 📑 Professional document exports in multiple formats (.odt, .doc, .pdf) with customizable templates
|
* 📑 Professional document exports in multiple formats (.odt, .doc, .pdf) with customizable templates
|
||||||
* 📚 Built-in wiki functionality to transform your team's collaborative work into organized knowledge `ETA 02/2025`
|
* 📚 Built-in wiki functionality to turn your team's collaborative work into organized knowledge `ETA 02/2025`
|
||||||
|
|
||||||
### Self-host
|
### Self-host
|
||||||
* 🚀 Easy to install, scalable and secure alternative to Notion, Outline or Confluence
|
* 🚀 Easy to install, scalable and secure alternative to Notion, Outline or Confluence
|
||||||
|
|
||||||
## Getting started 🔧
|
## Getting started 🔧
|
||||||
|
|
||||||
### Test it
|
### Test it
|
||||||
|
|
||||||
Test Docs on your browser by logging in on this [environment](https://impress-preprod.beta.numerique.gouv.fr/docs/0aa856e9-da41-4d59-b73d-a61cb2c1245f/)
|
Test Docs on your browser by logging in on this [environment](https://impress-preprod.beta.numerique.gouv.fr/docs/0aa856e9-da41-4d59-b73d-a61cb2c1245f/)
|
||||||
|
|
||||||
```
|
```
|
||||||
email: test.docs@yopmail.com
|
email: test.docs@yopmail.com
|
||||||
password: I'd<3ToTestDocs
|
password: I'd<3ToTestDocs
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run it locally
|
### Run it locally
|
||||||
|
|
||||||
|
> ⚠️ Running Docs locally using the methods described below is for testing purposes only. It is based on building Docs using Minio as the S3 storage solution: if you want to use Minio for production deployment of Docs, you will need to comply with Minio's AGPL-3.0 licence.
|
||||||
|
|
||||||
**Prerequisite**
|
**Prerequisite**
|
||||||
|
|
||||||
Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop:
|
Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop:
|
||||||
|
|
||||||
```shellscript
|
```shellscript
|
||||||
@@ -65,15 +74,14 @@ docker compose version 1.27.4, build 40524192
|
|||||||
> ⚠️ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group.
|
> ⚠️ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group.
|
||||||
|
|
||||||
**Project bootstrap**
|
**Project bootstrap**
|
||||||
|
|
||||||
The easiest way to start working on the project is to use GNU Make:
|
The easiest way to start working on the project is to use GNU Make:
|
||||||
|
|
||||||
```shellscript
|
```shellscript
|
||||||
$ make bootstrap FLUSH_ARGS='--no-input'
|
$ make bootstrap FLUSH_ARGS='--no-input'
|
||||||
```
|
```
|
||||||
|
|
||||||
This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this
|
This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
|
||||||
|
|
||||||
command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
|
|
||||||
|
|
||||||
Your Docker services should now be up and running 🎉
|
Your Docker services should now be up and running 🎉
|
||||||
|
|
||||||
@@ -126,6 +134,7 @@ $ make help
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Django admin**
|
**Django admin**
|
||||||
|
|
||||||
You can access the Django admin site at
|
You can access the Django admin site at
|
||||||
|
|
||||||
<http://localhost:8071/admin>.
|
<http://localhost:8071/admin>.
|
||||||
@@ -137,17 +146,21 @@ $ make superuser
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Feedback 🙋♂️🙋♀️
|
## Feedback 🙋♂️🙋♀️
|
||||||
|
|
||||||
We'd love to hear your thoughts and hear about your experiments, so come and say hi on [Matrix](https://matrix.to/#/#docs-official:matrix.org).
|
We'd love to hear your thoughts and hear about your experiments, so come and say hi on [Matrix](https://matrix.to/#/#docs-official:matrix.org).
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
Want to know where the project is headed? [🗺️ Checkout our roadmap](https://github.com/orgs/numerique-gouv/projects/13/views/11)
|
Want to know where the project is headed? [🗺️ Checkout our roadmap](https://github.com/orgs/numerique-gouv/projects/13/views/11)
|
||||||
|
|
||||||
## Licence 📝
|
## Licence 📝
|
||||||
|
|
||||||
This work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/LICENSE)).
|
This work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/LICENSE)).
|
||||||
|
|
||||||
While Docs is a public driven initiative our licence choice is an invitation for private sector actors to use, sell and contribute to the project.
|
While Docs is a public driven initiative our licence choice is an invitation for private sector actors to use, sell and contribute to the project.
|
||||||
|
|
||||||
## Contributing 🙌
|
## Contributing 🙌
|
||||||
|
|
||||||
This project is intended to be community-driven, so please, do not hesitate to [get in touch](https://matrix.to/#/#docs-official:matrix.org) if you have any question related to our implementation or design decisions.
|
This project is intended to be community-driven, so please, do not hesitate to [get in touch](https://matrix.to/#/#docs-official:matrix.org) if you have any question related to our implementation or design decisions.
|
||||||
|
|
||||||
You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
|
You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
|
||||||
@@ -169,10 +182,13 @@ docs
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Credits ❤️
|
## Credits ❤️
|
||||||
|
|
||||||
### Stack
|
### Stack
|
||||||
Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/)
|
|
||||||
|
Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/).
|
||||||
|
|
||||||
### Gov ❤️ open source
|
### Gov ❤️ open source
|
||||||
|
|
||||||
Docs is the result of a joint effort led by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)).
|
Docs is the result of a joint effort led by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)).
|
||||||
|
|
||||||
We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).
|
We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).
|
||||||
|
|||||||
Reference in New Issue
Block a user