New Version of the RIPE Database Documentation is Available
Dear Colleagues, The DB team are pleased to announce that a new version of the RIPE Database documentation is now available: https://apps.db.ripe.net/docs/ We are using a common framework that we have across many RIPE NCC technical services, such as RIPEstat, RIPE Atlas, RIS and RIPE IPmap. This framework has some advantages: * Allows us to use a more modern layout that is common across these services. * A built-in search field is now available at the top of each page. * The documentation is stored in Markdown format, making it easier for the team to make changes, and accept outside contributions. * We are now able to deploy changes together with a Whois or DB web application release. Under the hood, the new documentation uses the VuePress framework: https://vuepress.vuejs.org If you prefer not to use JavaScript, or to print or save the entire documentation, it is also available on a single page: https://apps.db.ripe.net/docs/entire-documentation-(HTML) The documentation contents are published on GitHub, please create a pull request or an issue to contribute improvements: https://github.com/RIPE-NCC/ripe-database-documentation Finally, we plan to migrate (redirect) the existing RIPE Database Documentation pages to the new site. https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-datab... Regards Ed Shryane RIPE NCC
This looks great! I just have one small question, why did you choose to have it on apps.db.ripe.net instead of some more general RIPE (NCC) services documentation thing to have it all in one place? I think it was RIS or Atlas that I saw that have this same style of docs so to me it would make some sense to collect it all in one easy to find place. It is not like it matters much and this is still very good but I just know that earlier I have sometimes had a bit of a difficult time navigating to the documentation for various RIPE (NCC) services. Regardless, great job DB team! -Cynthia On Fri, Jul 15, 2022 at 4:57 PM Edward Shryane via db-wg <db-wg@ripe.net> wrote:
Dear Colleagues,
The DB team are pleased to announce that a new version of the RIPE Database documentation is now available: https://apps.db.ripe.net/docs/
We are using a common framework that we have across many RIPE NCC technical services, such as RIPEstat, RIPE Atlas, RIS and RIPE IPmap.
This framework has some advantages:
* Allows us to use a more modern layout that is common across these services. * A built-in search field is now available at the top of each page. * The documentation is stored in Markdown format, making it easier for the team to make changes, and accept outside contributions. * We are now able to deploy changes together with a Whois or DB web application release.
Under the hood, the new documentation uses the VuePress framework: https://vuepress.vuejs.org
If you prefer not to use JavaScript, or to print or save the entire documentation, it is also available on a single page: https://apps.db.ripe.net/docs/entire-documentation-(HTML)
The documentation contents are published on GitHub, please create a pull request or an issue to contribute improvements: https://github.com/RIPE-NCC/ripe-database-documentation
Finally, we plan to migrate (redirect) the existing RIPE Database Documentation pages to the new site. https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-datab...
Regards Ed Shryane RIPE NCC
--
To unsubscribe from this mailing list, get a password reminder, or change your subscription options, please visit: https://lists.ripe.net/mailman/listinfo/db-wg
Hi Cynthia, Thanks for your feedback,
On 15 Jul 2022, at 17:12, Cynthia Revström <me@cynthia.re> wrote:
This looks great!
I just have one small question, why did you choose to have it on apps.db.ripe.net instead of some more general RIPE (NCC) services documentation thing to have it all in one place?
We co-host the DB documentation with the DB application because they belong together (the documentation also linked from the left-hand menu of the application), and it's easier for the DB team to keep updated (we can deploy changes ourselves with the application).
I think it was RIS or Atlas that I saw that have this same style of docs so to me it would make some sense to collect it all in one easy to find place.
You are correct, the other applications do use the same relative location (/docs/) for consistency.
It is not like it matters much and this is still very good but I just know that earlier I have sometimes had a bit of a difficult time navigating to the documentation for various RIPE (NCC) services.
I will discuss internally how to make all RIPE NCC services documentation accessible from one place (and easier to find). The DB documentation will continue to be linked from "Database Support" on the main website: https://www.ripe.net/manage-ips-and-asns/db/support
Regardless, great job DB team!
-Cynthia
Thank you! Regards Ed Shryane RIPE NCC
The reasoning totally makes sense to me. Honestly just having a good central place with links to documentation for the RIPE (NCC) services would solve the issue I had. -Cynthia On Mon, Jul 18, 2022, 09:39 Edward Shryane <eshryane@ripe.net> wrote:
Hi Cynthia,
Thanks for your feedback,
On 15 Jul 2022, at 17:12, Cynthia Revström <me@cynthia.re> wrote:
This looks great!
I just have one small question, why did you choose to have it on apps.db.ripe.net instead of some more general RIPE (NCC) services documentation thing to have it all in one place?
We co-host the DB documentation with the DB application because they belong together (the documentation also linked from the left-hand menu of the application), and it's easier for the DB team to keep updated (we can deploy changes ourselves with the application).
I think it was RIS or Atlas that I saw that have this same style of docs so to me it would make some sense to collect it all in one easy to find place.
You are correct, the other applications do use the same relative location (/docs/) for consistency.
It is not like it matters much and this is still very good but I just know that earlier I have sometimes had a bit of a difficult time navigating to the documentation for various RIPE (NCC) services.
I will discuss internally how to make all RIPE NCC services documentation accessible from one place (and easier to find).
The DB documentation will continue to be linked from "Database Support" on the main website: https://www.ripe.net/manage-ips-and-asns/db/support
Regardless, great job DB team!
-Cynthia
Thank you!
Regards Ed Shryane RIPE NCC
Hi Cynthia,
On 19 Jul 2022, at 02:25, Cynthia Revström <me@cynthia.re> wrote:
The reasoning totally makes sense to me.
Honestly just having a good central place with links to documentation for the RIPE (NCC) services would solve the issue I had.
-Cynthia
Our Comms team have added links to all the RIPE NCC services documentation under the "Get Support" menu at https://www.ripe.net Also visible at https://www.ripe.net/support/documentation Thanks for your feedback! Regards Ed Shryane RIPE NCC
Oh wow, honestly not sure how I missed that, thanks! -Cynthia On Tue, Jul 19, 2022 at 5:47 PM Edward Shryane <eshryane@ripe.net> wrote:
Hi Cynthia,
On 19 Jul 2022, at 02:25, Cynthia Revström <me@cynthia.re> wrote:
The reasoning totally makes sense to me.
Honestly just having a good central place with links to documentation for the RIPE (NCC) services would solve the issue I had.
-Cynthia
Our Comms team have added links to all the RIPE NCC services documentation under the "Get Support" menu at https://www.ripe.net
Also visible at https://www.ripe.net/support/documentation
Thanks for your feedback!
Regards Ed Shryane RIPE NCC
Hi Cynthia,
On 19 Jul 2022, at 19:05, Cynthia Revström <me@cynthia.re> wrote:
Oh wow, honestly not sure how I missed that, thanks!
-Cynthia
Sorry if I wasn't clear, the links *were* missing, our Comms team added them yesterday. Regards Ed Shryane RIPE NCC
participants (2)
-
Cynthia Revström -
Edward Shryane