Skip to content

Commit 55dabff

Browse files
committed
removed build information from readme
1 parent ee49542 commit 55dabff

File tree

1 file changed

+8
-24
lines changed

1 file changed

+8
-24
lines changed

README.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,19 @@
33

44
VuePress documentation for RIPE Database Documentation.
55

6-
This documentation is built automatically from nothing more than markdown files in the tree.
6+
This repo contains the documentation from [Database Documentation webpage](https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-documentation). This documentation is built automatically from nothing more than markdown files in the tree.
77

8-
# Editing the docs
8+
# Updating Documentation
99

10-
The docs can be edited directly within Gitlab or by cloning the repository, changing the files locally and checking them back in.
10+
We welcome updates to the documentation. Please open a pull request with your changes, or create an issue.
1111

12-
# Editing in Gitlab
12+
# VuePress
1313

14-
GitLab has handy built in editor that undestands most of the markdown that is in the markdown files. There are a few excetions that are particular to VuePress:
14+
This project depends on VuePress (https://vuepress.vuejs.org) to build the static site from Markdown.
1515

16-
| **Gitlab markdown** | **Vuepress markdown** |
17-
| --- | --- |
18-
| collapsible sections are rendered with <details><summary></summary><content></content></details> | collapsible sections rendered same as gitlab OR by ::: details summaryText contentText ::: |
19-
Embedded vue components are ignored | Embedded vue components (like <RestRepl />) are recognized and rendered |
16+
The VuePress configuration and components are not yet public, so are not included for now.
2017

21-
# Running commands
18+
# License
2219

23-
**Do not use yarn command, it has problems with some dependency**
20+
The documentation is covered by the terms of the [license](LICENSE.md).
2421

25-
Once you download the repository in your local machine you have to run the next commands.
26-
27-
npm install
28-
29-
This command is going to install the required dependencies for vuepress and those dependencies specified in package-lock.json file. The output of this command is a new folder called node_modules that contains all the installed dependencies.
30-
31-
npm run docs:dev
32-
33-
This command is going to launch a local server in http://localhost:8080/docs/
34-
35-
# Legal
36-
37-
**IMPORTANT!** Any change done to [legal](./docs/24.Legal-Information.md), [T&C](./docs/24.HTML-Terms-And-Conditions.md) or [AUP](./docs/23.RIPE-Database-Acceptable-Use-Policy.md) require approval from Legal. So please don't edit those files unless you have the permission from Legal.

0 commit comments

Comments
 (0)