From 32652cce15d200363c0dbaf5d2c6c41621f51e73 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 18:03:01 +0100 Subject: install: overall chapter improvement --- docs/contributing/issues-features.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/contributing/issues-features.rst') diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst index 3a1738d7..04efbd22 100644 --- a/docs/contributing/issues-features.rst +++ b/docs/contributing/issues-features.rst @@ -3,6 +3,8 @@ Issues/Feature requests ======================= +.. _bug_report: + Bug Report/Issue ---------------- Issues or bugs are found in any software project. VyOS is not an exception. -- cgit v1.2.3 From 1499918804a16051c44d2ee248c067f25e617185 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 29 Dec 2019 11:07:22 +0100 Subject: common-references: migrate all VyOS Phabricator references --- docs/common-references.rst | 1 + docs/contributing/development.rst | 3 ++- docs/contributing/documentation.rst | 3 ++- docs/contributing/issues-features.rst | 10 ++++++---- docs/vpn/openvpn.rst | 6 ++++-- 5 files changed, 15 insertions(+), 8 deletions(-) (limited to 'docs/contributing/issues-features.rst') diff --git a/docs/common-references.rst b/docs/common-references.rst index 9f0b9b84..d7e376eb 100644 --- a/docs/common-references.rst +++ b/docs/common-references.rst @@ -1,2 +1,3 @@ .. _`accel-ppp`: https://accel-ppp.org/ .. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol +.. _Phabricator: https://phabricator.vyos.net/ diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 35b9e17a..fed06e6f 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -695,10 +695,11 @@ http://dev.packages.vyos.net/repositories/. .. _VyConf: https://github.com/vyos/vyconf/tree/master/data/schemata .. _vyos-1x: https://github.com/vyos/vyos-1x/tree/current/schema .. _Jinja2: https://jinja.palletsprojects.com/ -.. _Phabricator: https://phabricator.vyos.net/ .. _Jenkins: https://jenkins.io/ .. _Dockerhub: https://hub.docker.com/u/vyos/ .. _`IPv4, IPv6 and DHCP(v6)`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/address-ipv4-ipv6-dhcp.xml.i .. _`IPv4, IPv6`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/address-ipv4-ipv6.xml.i .. _`VLAN (VIF)`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/vif.xml.i .. _`MAC address`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/interface-mac.xml.i + +.. include:: ../common-references.rst diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 48cc063b..c639651b 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -171,5 +171,6 @@ be added below this statement. .. _Sphinx-doc: https://www.sphinx-doc.org .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html -.. _Phabricator: https://phabricator.vyos.net .. _README.md: https://github.com/vyos/vyos-documentation/blob/master/README.md + +.. include:: ../common-references.rst diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst index 04efbd22..e208a3e6 100644 --- a/docs/contributing/issues-features.rst +++ b/docs/contributing/issues-features.rst @@ -51,9 +51,10 @@ also contain information that is helpful for the development team. Report a Bug ************ -Create an account on VyOS Phabricator_. Phabricator_ is located at -https://phabricator.vyos.net. To create a bug-report use the quick link in the -left side under the specific project. +In order to open up a bug-report/feature request you need to create yourself +an account on VyOS Phabricator_. On the left side of the specific project (VyOS +1.2 or VyOS 1.3) you will find quick-links for opening a bug-report/feature +request. * Provide as much information as you can * Which version of VyOS are you using? ``run show version`` @@ -71,4 +72,5 @@ the left side under the specific project. .. _documentation: https://docs.vyos.io .. _Slack: https://slack.vyos.io .. _Forum: https://forum.vyos.io -.. _Phabricator: https://phabricator.vyos.net \ No newline at end of file + +.. include:: ../common-references.rst \ No newline at end of file diff --git a/docs/vpn/openvpn.rst b/docs/vpn/openvpn.rst index 69961f0c..cbb89fbe 100644 --- a/docs/vpn/openvpn.rst +++ b/docs/vpn/openvpn.rst @@ -441,8 +441,8 @@ Options ======= We do not have CLI nodes for every single OpenVPN options. If an option is -missing, a feature request should be opened at https://phabricator.vyos.net so -all users can benefit from it. +missing, a feature request should be opened at Phabricator_ so all users can +benefit from it (see :ref:`issues_features`). If you are a hacker or want to try on your own we support passing raw OpenVPN options to OpenVPN. @@ -460,3 +460,5 @@ Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file. .. note:: Sometimes option lines in the generated OpenVPN configurarion require quotes. This is done through a hack on our config generator. You can pass quotes using the ``"`` statement. + +.. include:: ../common-references.rst -- cgit v1.2.3 From ed82d6b00e6ed32b3d056f0623822d61c6c599f6 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 29 Dec 2019 11:10:38 +0100 Subject: issue-feature: use documented section style guide --- docs/contributing/issues-features.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'docs/contributing/issues-features.rst') diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst index e208a3e6..553522a1 100644 --- a/docs/contributing/issues-features.rst +++ b/docs/contributing/issues-features.rst @@ -1,12 +1,14 @@ .. _issues_features: +####################### Issues/Feature requests ======================= .. _bug_report: Bug Report/Issue ----------------- +================ + Issues or bugs are found in any software project. VyOS is not an exception. All issues should be reported to the developers. This lets the developers know @@ -14,7 +16,7 @@ what is not working properly. Without this sort of feedback every developer will believe that everything is working correctly. I have found a bug, what should I do? -************************************* +------------------------------------- When you believe you have found a bug, it is always a good idea to verify the issue prior to opening a bug request. @@ -24,7 +26,7 @@ issue prior to opening a bug request. * Get community support via Slack_ or our Forum_ Ensure the problem is reproducible -********************************** +---------------------------------- When you are able to verify that it is actually a bug, spend some time to document how to reproduce the issue. This documentation can be invaluable. @@ -40,7 +42,7 @@ information can be very useful. * What commands did you use? Use e.g. ``run show configuration commands`` Include output -************** +-------------- The output you get when you find a bug can provide lots of information. If you get an error message on the screen, copy it exactly. Having the exact message @@ -49,7 +51,7 @@ messages that also are from the time of the issue, include those. They may also contain information that is helpful for the development team. Report a Bug -************ +------------ In order to open up a bug-report/feature request you need to create yourself an account on VyOS Phabricator_. On the left side of the specific project (VyOS @@ -60,8 +62,10 @@ request. * Which version of VyOS are you using? ``run show version`` * How can we reproduce this Bug? +.. _feature_request: + Feature Request ---------------- +=============== You have an idea of how to make VyOS better or you are in need of a specific feature which all users of VyOS would benefit from? To send a feature request -- cgit v1.2.3 From 63d79bfbc887f306bca842986b823a1ee38ace13 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 29 Dec 2019 17:13:44 +0100 Subject: issue-feature: fix title overline & underline mismatch --- docs/contributing/issues-features.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/contributing/issues-features.rst') diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst index 553522a1..1c6563b9 100644 --- a/docs/contributing/issues-features.rst +++ b/docs/contributing/issues-features.rst @@ -2,7 +2,7 @@ ####################### Issues/Feature requests -======================= +####################### .. _bug_report: -- cgit v1.2.3