Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix nav subsections #170

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 54 additions & 54 deletions source/configuration.rst → source/configuration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:og:description: Create and maintain a working configuration using
listeners, routes, apps, and upstreams.

.. include:: include/replace.rst
.. include:: ../include/replace.rst

#############
Configuration
Expand Down Expand Up @@ -2228,7 +2228,7 @@ affects the resulting response headers.
The values support
:ref:`variables <configuration-variables>`
and
:doc:`template literals <scripting>`,
:doc:`template literals <../scripting>`,
which enables arbitrary runtime logic:

.. code-block:: json
Expand Down Expand Up @@ -2441,7 +2441,7 @@ A **share**-based action provides the following options:
<installation-precomp-pkgs>`,
the process runs as **unit:unit**;
for details of other installation methods,
see :doc:`installation`.
see :doc:`../installation`.

Consider the following configuration:

Expand Down Expand Up @@ -3988,7 +3988,7 @@ and rebuild the app.
# yum install unit-devel

- If you installed Unit from
:doc:`source <howto/source>`,
:doc:`source <../howto/source>`,
install the include files and libraries:

.. code-block:: console
Expand Down Expand Up @@ -4101,7 +4101,7 @@ Example:

For Go-based examples,
see our
:doc:`howto/grafana`
:doc:`../howto/grafana`
howto or a basic
:ref:`sample <sample-go>`.

Expand Down Expand Up @@ -4191,10 +4191,10 @@ Example:

For Java-based examples,
see our
:doc:`howto/jira`,
:doc:`howto/opengrok`,
:doc:`../howto/jira`,
:doc:`../howto/opengrok`,
and
:doc:`howto/springboot`
:doc:`../howto/springboot`
howtos or a basic
:ref:`sample <sample-java>`.

Expand Down Expand Up @@ -4343,9 +4343,9 @@ your app only needs to replace the default **websocket**:

For Node.js-based examples,
see our
:doc:`howto/apollo`,
:doc:`howto/express`,
:doc:`howto/koa`,
:doc:`../howto/apollo`,
:doc:`../howto/express`,
:doc:`../howto/koa`,
and
:ref:`Docker <docker-apps>`
howtos or a basic
Expand Down Expand Up @@ -4412,9 +4412,9 @@ Example:

For Perl-based examples of Perl,
see our
:doc:`howto/bugzilla`
:doc:`../howto/bugzilla`
and
:doc:`howto/catalyst`
:doc:`../howto/catalyst`
howtos or a basic
:ref:`sample <sample-perl>`.

Expand Down Expand Up @@ -4665,23 +4665,23 @@ are shared by all targets within the app.

For PHP-based examples,
see our
:doc:`howto/cakephp`,
:doc:`howto/codeigniter`,
:doc:`howto/dokuwiki`,
:doc:`howto/drupal`,
:doc:`howto/laravel`,
:doc:`howto/lumen`,
:doc:`howto/matomo`,
:doc:`howto/mediawiki`,
:doc:`howto/modx`,
:doc:`howto/nextcloud`,
:doc:`howto/phpbb`,
:doc:`howto/phpmyadmin`,
:doc:`howto/roundcube`,
:doc:`howto/symfony`,
:doc:`howto/wordpress`,
:doc:`../howto/cakephp`,
:doc:`../howto/codeigniter`,
:doc:`../howto/dokuwiki`,
:doc:`../howto/drupal`,
:doc:`../howto/laravel`,
:doc:`../howto/lumen`,
:doc:`../howto/matomo`,
:doc:`../howto/mediawiki`,
:doc:`../howto/modx`,
:doc:`../howto/nextcloud`,
:doc:`../howto/phpbb`,
:doc:`../howto/phpmyadmin`,
:doc:`../howto/roundcube`,
:doc:`../howto/symfony`,
:doc:`../howto/wordpress`,
and
:doc:`howto/yii`
:doc:`../howto/yii`
howtos or a basic
:ref:`sample <sample-php>`.

Expand Down Expand Up @@ -4972,27 +4972,27 @@ are shared by all targets in the app.

For Python-based examples,
see our
:doc:`howto/bottle`,
:doc:`howto/datasette`,
:doc:`howto/django`,
:doc:`howto/djangochannels`,
:doc:`howto/falcon`,
:doc:`howto/fastapi`,
:doc:`howto/flask`,
:doc:`howto/guillotina`,
:doc:`howto/mailman`,
:doc:`howto/mercurial`,
:doc:`howto/moin`,
:doc:`howto/plone`,
:doc:`howto/pyramid`,
:doc:`howto/quart`,
:doc:`howto/responder`,
:doc:`howto/reviewboard`,
:doc:`howto/sanic`,
:doc:`howto/starlette`,
:doc:`howto/trac`,
:doc:`../howto/bottle`,
:doc:`../howto/datasette`,
:doc:`../howto/django`,
:doc:`../howto/djangochannels`,
:doc:`../howto/falcon`,
:doc:`../howto/fastapi`,
:doc:`../howto/flask`,
:doc:`../howto/guillotina`,
:doc:`../howto/mailman`,
:doc:`../howto/mercurial`,
:doc:`../howto/moin`,
:doc:`../howto/plone`,
:doc:`../howto/pyramid`,
:doc:`../howto/quart`,
:doc:`../howto/responder`,
:doc:`../howto/reviewboard`,
:doc:`../howto/sanic`,
:doc:`../howto/starlette`,
:doc:`../howto/trac`,
and
:doc:`howto/zope`
:doc:`../howto/zope`
howtos or a basic
:ref:`sample <sample-python>`.

Expand Down Expand Up @@ -5110,9 +5110,9 @@ to your app.

For Ruby-based examples,
see our
:doc:`howto/rails`
:doc:`../howto/rails`
and
:doc:`howto/redmine`
:doc:`../howto/redmine`
howtos or a basic
:ref:`sample <sample-ruby>`.

Expand Down Expand Up @@ -5366,9 +5366,9 @@ that stores instance-wide preferences.
- String or an array of strings;
lists enabled
:program:`njs`
:doc:`modules <scripting>`,
:doc:`modules <../scripting>`,
uploaded
via the :doc:`control API <controlapi>`.
via the :doc:`control API <../controlapi>`.

In turn, the **http** option exposes the following settings:

Expand Down Expand Up @@ -5591,7 +5591,7 @@ is formed *after* the request has been handled.
Besides
:ref:`built-in variables <configuration-variables-native>`,
you can use :program:`njs`
:doc:`templates <scripting>`
:doc:`templates <../scripting>`
to define the log format:

.. code-block:: json
Expand Down
3 changes: 1 addition & 2 deletions source/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@
news
installation
controlapi
configuration
configuration/index
scripting
certificates
statusapi
unitctl
howto/index
troubleshooting
community
2 changes: 1 addition & 1 deletion source/controlapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ that comprises four primary options:

* - **/config**
- Used for general
:doc:`configuration management <configuration>`.
:doc:`configuration management <configuration/index>`.

* - **/control**
- Queried for
Expand Down
4 changes: 2 additions & 2 deletions source/howto/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ notorious **777**, instead assigning them on a need-to-know basis.
# find :nxt_ph:`/path/to/app/ <Path to the application directory; use a real path in your command>` -type f -exec :nxt_hint:`chmod <Add read and execute rights to app code for user and group>` u=rx,g=rx,o= {} \;
# find :nxt_ph:`/path/to/static/app/files/ <Can be outside the app directory tree; use a real path in your command>` -type f -exec :nxt_hint:`chmod <Add read rights to static files for user and group>` u=r,g=r,o= {} \;

#. To run a single app, :doc:`configure <../configuration>` Unit as follows:
#. To run a single app, :doc:`configure <../configuration/index>` Unit as follows:

.. code-block:: json

Expand Down Expand Up @@ -397,7 +397,7 @@ notorious **777**, instead assigning them on a need-to-know basis.
}
}

#. To run several apps side by side, :doc:`configure <../configuration>`
#. To run several apps side by side, :doc:`configure <../configuration/index>`
them with appropriate user and group names. The following
configuration distinguishes apps based on the request URI, but you can
implement another scheme such as different listeners:
Expand Down
2 changes: 1 addition & 1 deletion source/news/2019/unit-1.8.0-released.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ applications, and leave us feedback. If you're a Jira user, please use this
HowTo: https://unit.nginx.org/howto/jira/

More documentation is available in :doc:`../../installation` and
:doc:`../../configuration` sections.
:doc:`../../configuration/index` sections.

We intend to use our open-development process to refine and improve the
software and to eventually test and certify the software's compatibility
Expand Down
2 changes: 1 addition & 1 deletion source/scripting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ JavaScript expressions, including function calls, in the form of
<https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals>`__
written in
`NGINX JavaScript <https://nginx.org/en/docs/njs/>`__ ( :program:`njs` ).
They can be used with these :doc:`configuration <configuration>` options:
They can be used with these :doc:`configuration <configuration/index>` options:

- **pass** in
:ref:`listeners <configuration-listeners>`
Expand Down