Skip to content

Commit

Permalink
doc: fix the check command examples
Browse files Browse the repository at this point in the history
  • Loading branch information
@azmeuk
azmeuk committed Feb 3, 2025
1 parent a303684 commit e57eccd
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 21 deletions.
61 changes: 43 additions & 18 deletions doc/locales/doc.pot
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: canaille 0.0.59\n"
"Project-Id-Version: canaille 0.0.60\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-01-31 10:03+0100\n"
"POT-Creation-Date: 2025-02-03 22:58+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand All @@ -33,7 +33,7 @@ msgstr ""

#: ../../CHANGES.rst:2
#: c40cc30bc9f847b1ba5d4c38c0da1c66
msgid "[0.0.60] - Unreleased"
msgid "[0.0.60] - 2025-02-03"
msgstr ""

#: ../../CHANGES.rst:5
Expand Down Expand Up @@ -2354,7 +2354,7 @@ msgstr ""

#: ../../CONTRIBUTING.rst:256
#: dc74511803ac4bd6bc003b9019d1a93b
msgid "Check that dependencies are up to date with ``uv sync --all-extras --upgrade`` and update dependencies accordingly in separated commits;"
msgid "Check that dependencies are up to date with ``uv sync --all-extras --all-groups --upgrade`` and update dependencies accordingly in separated commits;"
msgstr ""

#: ../../CONTRIBUTING.rst:257
Expand Down Expand Up @@ -2384,30 +2384,45 @@ msgstr ""

#: ../../CONTRIBUTING.rst:262
#: da47fe881bd140a0948a1b71ca9d197f
msgid ":ref:`Build the packages <development/contributing:Build a release>`;"
msgid ":ref:`Build the packages <development/contributing:Build a release>` with ``uv build``;"
msgstr ""

#: ../../CONTRIBUTING.rst:263
#: 706d5c088f4d48a9b413baabe4fdd18a
msgid "Install from the .whl generated with ``uv pip install <path/to/dist/canaille-x.x.xx-py3-none-any.whl>[front,oidc,postgresql,server,otp,sms]``;"
msgstr ""

#: ../../CONTRIBUTING.rst:264
#: e69352aa875546b0a838f072020fb153
msgid "Test creation of a user with ``canaille config dump`` and ``canaille create user --user-name admin --password admin --emails [email protected] --given-name George --family-name Abitbol`` and ``canaille run``;"
msgstr ""

#: ../../CONTRIBUTING.rst:265
#: 0427c7ae5e6142f2bb32a5267ab9ef54
msgid "Try to connect the user;"
msgstr ""

#: ../../CONTRIBUTING.rst:266
#: 59e6a194497f40589f9cadbc4819dac3
msgid "Publish the Python package on test PyPI with ``uv publish --publish-url https://test.pypi.org/legacy/``;"
msgstr ""

#: ../../CONTRIBUTING.rst:264
#: ../../CONTRIBUTING.rst:267
#: a76e7b5698e146a3aeb30fd210520018
msgid "Install the test package somewhere with ``pip install --extra-index-url https://test.pypi.org/simple --upgrade canaille``. Check that everything looks fine;"
msgid "Install the test package somewhere with ``pip install --extra-index-url https://test.pypi.org/simple --upgrade \"canaille[front,oidc,postgresql,server,otp,sms]\"``. Check that everything looks fine;"
msgstr ""

#: ../../CONTRIBUTING.rst:265
#: ../../CONTRIBUTING.rst:268
#: bdbcc97321eb4f72a89ace044fa421a6
msgid "Publish the Python package on production PyPI ``uv publish``;"
msgstr ""

#: ../../CONTRIBUTING.rst:266
#: ../../CONTRIBUTING.rst:269
#: 0cad7a4363db4ad7be4b1c69bd9b9565
msgid "Tag the commit with ``git tag XX.YY.ZZ``;"
msgstr ""

#: ../../CONTRIBUTING.rst:267
#: ../../CONTRIBUTING.rst:270
#: f4131a01f96f47ceb519fff58f04cdde
msgid "Push the release commit and the new tag on the repository with ``git push --tags``."
msgstr ""
Expand Down Expand Up @@ -3771,8 +3786,8 @@ msgid "Handle Canaille configuration file."
msgstr ""

#: ../../canaille config check:1
#: 87ca1bdf716e428baf705bacf87f4c09
msgid "Test the configuration file."
#: c3e71c1ec5b545548c6f010ba00e3892
msgid "Test the network connections defined in the configuration file."
msgstr ""

#: ../../canaille config check:1
Expand Down Expand Up @@ -4853,6 +4868,16 @@ msgstr ""
msgid "SCIM settings."
msgstr ""

#: ../../docstring of canaille.scim.configuration.SCIMSettings.ENABLE_SERVER:1
#: 1ee1bebd3892435980098de1b3dfee84
msgid "Whether the SCIM server API is enabled."
msgstr ""

#: ../../docstring of canaille.scim.configuration.SCIMSettings.ENABLE_SERVER:3
#: ed0b4db3345942a2a24deb3625522f84
msgid "When enabled, services plugged to Canaille can update users and groups using the API."
msgstr ""

#: ../../canaille/backends/sql/configuration.py:docstring of canaille.backends.sql.configuration.SQLSettings:1
#: 92d2dc92ffa74589b25aee4f5755709f
msgid "Settings related to the SQL backend."
Expand Down Expand Up @@ -4920,7 +4945,7 @@ msgstr ""

#: ../../docstring of canaille.backends.ldap.configuration.LDAPSettings.GROUP_BASE:3
#: 2900a3f68b294d53bf586c784b38ef6c
msgid "For instance `\"ou=groups,dc=mydomain,dc=tld\"`."
msgid "For instance `\"ou=groups,dc=example,dc=org\"`."
msgstr ""

#: ../../docstring of canaille.backends.ldap.configuration.LDAPSettings.GROUP_CLASS:1
Expand Down Expand Up @@ -4960,7 +4985,7 @@ msgstr ""

#: ../../docstring of canaille.backends.ldap.configuration.LDAPSettings.USER_BASE:3
#: eccfba5ea42049468d3c2ecd56873d3d
msgid "For instance `ou=users,dc=mydomain,dc=tld`."
msgid "For instance `ou=users,dc=example,dc=org`."
msgstr ""

#: ../../docstring of canaille.backends.ldap.configuration.LDAPSettings.USER_CLASS:1
Expand Down Expand Up @@ -6917,16 +6942,16 @@ msgid "Check"
msgstr ""

#: ../tutorial/install.rst:128
#: a3ac73ceacfd4b1094eddddc3c6db17a
msgid "After a manual installation, you can check your configuration file using the :ref:`check command <cli_install>`:"
#: 53dcacb4539040ba96b3aaf4ab82e8df
msgid "After a manual installation, you can test the network parameters in your configuration file using the :ref:`check command <cli_install>`. It will attempt to connect your :class:`SMTP server <canaille.core.configuration.SMTPSettings>`, or your :class:`SMPP server <canaille.core.configuration.SMPPSettings>` if defined."
msgstr ""

#: ../tutorial/install.rst:135
#: ../tutorial/install.rst:136
#: 1ee2a32a0cd342b8abb212d6cfe4cb4d
msgid "Create the first user"
msgstr ""

#: ../tutorial/install.rst:137
#: ../tutorial/install.rst:138
#: 15d31e7c0ac74a139bf75b1f0b1a298d
msgid "Once canaille is installed, soon enough you will need to add users. To create your first user you can use the :ref:`canaille create <cli_create>` CLI."
msgstr ""
Expand Down
7 changes: 4 additions & 3 deletions doc/tutorial/install.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This page describes how to get and set-up Canaille.
canaille config dump
$EDITOR $CONFIG
canaille install
canaille check
canaille config check
canaille create user --user-name admin --password admin --emails [email protected] --given-name George --family-name Abitbol
Get the code
Expand Down Expand Up @@ -125,11 +125,12 @@ Depending on the configured :doc:`database <databases>` it will create the SQL t
Check
=====

After a manual installation, you can check your configuration file using the :ref:`check command <cli_install>`:
After a manual installation, you can test the network parameters in your configuration file using the :ref:`check command <cli_install>`.
It will attempt to connect your :class:`SMTP server <canaille.core.configuration.SMTPSettings>`, or your :class:`SMPP server <canaille.core.configuration.SMPPSettings>` if defined.

.. code-block:: bash
canaille check
canaille config check
Create the first user
=====================
Expand Down

0 comments on commit e57eccd

Please sign in to comment.