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

docs: Release 1.33 news doc #168

Merged
merged 48 commits into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
e57bf56
docs: add CLI doc draft
Jcahilltorre Aug 1, 2024
9c7093f
docs: update based on feedback
Jcahilltorre Aug 6, 2024
46704bb
docs: update CLI
Jcahilltorre Aug 6, 2024
404516e
Apply suggestions from code review
Jcahilltorre Aug 6, 2024
3d8cf53
Apply suggestions from code review
Jcahilltorre Aug 6, 2024
e7169b3
Apply suggestions from code review
Jcahilltorre Aug 6, 2024
2e40b88
Update source/unitctl.rst
Jcahilltorre Aug 6, 2024
c75c10a
Update source/unitctl.rst
Jcahilltorre Aug 6, 2024
aa1d932
Update source/unitctl.rst
Jcahilltorre Aug 6, 2024
94f91e3
Update source/unitctl.rst
Jcahilltorre Aug 6, 2024
db57049
Update source/unitctl.rst
Jcahilltorre Aug 6, 2024
23a127d
Apply suggestions from code review
Jcahilltorre Aug 7, 2024
8699d5c
docs: preliminary draft
Jcahilltorre Aug 27, 2024
85282d7
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Aug 27, 2024
2c816c0
docs: update doc
Jcahilltorre Aug 28, 2024
1c6b1fe
Merge pull request #161 from nginx/unitctl-docs
Jcahilltorre Aug 28, 2024
1e26893
docs: update news
Jcahilltorre Aug 28, 2024
934f65a
docs: update date
Jcahilltorre Aug 28, 2024
3180b8f
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Aug 28, 2024
47faede
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Aug 28, 2024
a7fb364
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Aug 28, 2024
1e91444
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Aug 28, 2024
f14d729
docs: fixes
Jcahilltorre Aug 28, 2024
9229ec7
docs: options in bold
Jcahilltorre Aug 28, 2024
6d1c2e5
docs: update news desc.
Jcahilltorre Sep 2, 2024
865929e
docs: remove `a` (regression)
Jcahilltorre Sep 2, 2024
b3e25c7
fix: fix previews
Jcahilltorre Sep 2, 2024
f283a05
fix: fix nav subsections
Jcahilltorre Sep 3, 2024
c05c130
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Sep 3, 2024
b54745e
Merge pull request #170 from nginx/issue-169
Jcahilltorre Sep 4, 2024
d3f8259
docs: update features, config options, all of fame
Jcahilltorre Sep 5, 2024
203dbc6
Update source/news/2024/unit-1.33.0-released.rst
Jcahilltorre Sep 9, 2024
1340b06
docs: add bugfix
Jcahilltorre Sep 10, 2024
dba084a
docs: remove sudo on copy
Jcahilltorre Sep 11, 2024
d91b4fe
docs: add changes from PR 167
Jcahilltorre Sep 12, 2024
147e7f0
docs: split code blocks
Jcahilltorre Sep 12, 2024
796f7ea
docs: update release 1.33 date
Jcahilltorre Sep 16, 2024
48bf2ad
docs: update factory description
Jcahilltorre Sep 16, 2024
09c5995
docs: add unitctl note
Jcahilltorre Sep 16, 2024
8249097
docs: note updates
Jcahilltorre Sep 16, 2024
4f13e65
Merge pull request #174 from nginx/release-1.33-note
Jcahilltorre Sep 16, 2024
70bc453
Update source/unitctl.rst
Jcahilltorre Sep 17, 2024
3be24ca
Update source/unitctl.rst
Jcahilltorre Sep 17, 2024
f944bc4
Update source/unitctl.rst
Jcahilltorre Sep 17, 2024
9a7658d
Update source/unitctl.rst
Jcahilltorre Sep 17, 2024
dc4070b
Update source/unitctl.rst
Jcahilltorre Sep 17, 2024
4c63353
Update source/unitctl.rst
Jcahilltorre Sep 17, 2024
43dfe74
docs: update dates
Jcahilltorre Sep 18, 2024
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
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
project = 'NGINX Unit'
author = 'NGINX, Inc.'
copyright = '2017-2024'
version = '1.32.1'
release_date = 'Mar 26, 2024'
version = '1.33.0'
release_date = 'Aug 29, 2024'
Jcahilltorre marked this conversation as resolved.
Show resolved Hide resolved
release = version
needs_sphinx = '6.2'

Expand Down
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
2 changes: 1 addition & 1 deletion source/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
news
installation
controlapi
configuration
configuration/index
scripting
certificates
statusapi
Expand Down
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
8 changes: 8 additions & 0 deletions source/news/2024/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ News of 2024

News archive for the year 2024.

.. nxt_news_entry::
:author: Unit Team
:description: Version 1.33.0 includes three new configuration options and a CLI tool.
:email: [email protected]
:title: Unit 1.33.0 Released
:url: news/2024/unit-1.33.0-released
:date: 2024-08-29
Jcahilltorre marked this conversation as resolved.
Show resolved Hide resolved

.. nxt_news_entry::
:author: Unit Team
:description: Version 1.32.1 is a maintenance release that fixes bugs in the new WebAssembly Language Module and in our njs implementation.
Expand Down
Loading