Skip to content

Commit

Permalink
docs(readme): remove warning block, fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
javierbertoli committed Feb 3, 2022
1 parent 9c3e0c7 commit 9f13013
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 29 deletions.
2 changes: 1 addition & 1 deletion docs/README.apt.keyrings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ in favor of using `keyring files` which contain a binary OpenPGP format of the k
As nginx and passenger don't provide such key files, we created them following the
official recomendations in their sites and install the resulting files.

Ngninx
Nginx
------

See https://nginx.org/en/linux_packages.html#Debian for details
Expand Down
28 changes: 0 additions & 28 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,6 @@ nginx-formula

Formula to set up and configure `NGINX <https://www.nginx.com/>`_.

.. list-table::
:name: banner-breaking-changes-v1.0.0
:header-rows: 1
:widths: 1

* - WARNING: BREAKING CHANGES SINCE ``v1.0.0``
* - Prior to
`v1.0.0 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v1.0.0>`_,
this formula provided two methods for managing NGINX;
the old method under ``nginx`` and the new method under ``nginx.ng``.
The old method has now been removed and ``nginx.ng`` has been promoted to
be ``nginx`` in its place.

If you are not in a position to migrate, please pin your repo to the final
release tag before
`v1.0.0 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v1.0.0>`_,
i.e.
`v0.56.1 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v0.56.1>`_.

To migrate from ``nginx.ng``, simply modify your pillar to promote the
entire section under ``nginx:ng`` so that it is under ``nginx`` instead.
So with the editor of your choice, highlight the entire section and then
unindent one level. Finish by removing the ``ng:`` line.

To migrate from the old ``nginx``, first convert to ``nginx.ng`` under
`v0.56.1 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v0.56.1>`_
and then follow the steps laid out in the paragraph directly above.

.. contents:: **Table of Contents**

General notes
Expand Down

0 comments on commit 9f13013

Please sign in to comment.