Update README.md (#81)

--------- Co-authored-by: Erin Conley <[email protected]>
canonical · Jan 16, 2025 · 1301d0a · 1301d0a
1 parent 84d2c34
commit 1301d0a
Show file tree

Hide file tree

Showing 22 changed files with 46 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -5,40 +5,37 @@
 
 # SMTP Integrator Operator
 
-A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators)
-deploying and managing a SMTP Integrator on Kubernetes and bare metal. SMTP
-is an Internet standard communication protocol for email transmission.
-
-This charm simplifies configuration of SMTP client by providing a single point
-of configuration for all the requirers using the same SMTP server. It can be
-deployed on many different Kubernetes platforms, from [MicroK8s](https://microk8s.io)
-to [Charmed Kubernetes](https://ubuntu.com/kubernetes), public cloud Kubernetes
-offerings and virtual machines or bare metal.
-
-As such, the charm makes it easy to manage and propagate SMTP configuration, while
-giving the freedom to deploy on the substrate of their choice.
+A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) 
+for deploying and managing an SMTP integrator on Kubernetes or bare metal. 
+The SMTP integrator provides SMTP connection information to other charms 
+that require `smtp` integration, facilitating the email-sending capabilities 
+of those charms.
 
 For DevOps or SRE teams this charm will make operating any charm requiring SMTP
 authentication simple and straightforward through Juju's clean interface.
 
-## Project and community
+For information about how to deploy, integrate, and manage this charm,
+see the Official [SMTP Integrator Operator Documentation](https://charmhub.io/smtp-integrator).
 
-The SMTP Integrator Operator is a member of the Ubuntu family. It's an open source
-project that warmly welcomes community projects, contributions, suggestions,
-fixes and constructive feedback.
-* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
-* [Get support](https://discourse.charmhub.io/)
-* [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev)
-* [Contribute](https://charmhub.io/smtp-integrator/docs/how-to-contribute)
-Thinking about using the SMTP Integrator Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
+## Get started
 
-## Contributing to this documentation
+You can follow the tutorial [here](https://charmhub.io/smtp-integrator/docs/tutorial-getting-started).
 
-Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://charmhub.io/smtp-integrator/docs) to enable easy collaboration. Please use the "Help us improve this documentation" links on each documentation page to either directly change something you see that's wrong, ask a question, or make a suggestion about a potential change via the comments section.
+### Basic operations
 
-If there's a particular area of documentation that you'd like to see that's missing, please [file a bug](https://github.com/canonical/smtp-integrator-operator/issues).
+The smtp-integrator charm is a charm intended to be used to provide SMTP 
+connection information via the `smtp` Juju integration to other charms. 
+The smtp-integrator charm is first configured with the desired SMTP connection
+information, and any charm that integrates with the smtp-integrator 
+charm can obtain the configured SMTP connection information via the 
+`smtp` Juju integration.
 
----
+## Learn more
+* [Read more](https://charmhub.io/smtp-integrator)
+* [SAML specification](https://www.oasis-open.org/standard/smtp/)
+* [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
 
-For further details,
-[see the charm's detailed documentation](https://charmhub.io/smtp-integrator/docs).
+## Project and community
+* [Issues](https://github.com/canonical/smtp-integrator-operator/issues)
+* [Contributing](https://charmhub.io/smtp-integrator/docs/how-to-contribute)
+* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
diff --git a/charmcraft.yaml b/charmcraft.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 type: charm
 bases:

diff --git a/config.yaml b/config.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 options:

diff --git a/generate-src-docs.sh b/generate-src-docs.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 lazydocs --no-watermark --output-path src-docs src/*
diff --git a/lib/charms/smtp_integrator/v0/smtp.py b/lib/charms/smtp_integrator/v0/smtp.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # Licensed under the Apache2.0. See LICENSE file in charm source for details.
 
 """Library to manage the integration with the SMTP Integrator charm.
@@ -68,7 +68,7 @@ def _on_config_changed(self, _) -> None:
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 13
+LIBPATCH = 14
 
 PYDEPS = ["pydantic>=2"]
 

diff --git a/metadata.yaml b/metadata.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 name: smtp-integrator
 display-name: SMTP Integrator

diff --git a/src/charm.py b/src/charm.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """SMTP Integrator Charm service."""

diff --git a/src/charm_state.py b/src/charm_state.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Module defining the CharmState class which represents the state of the SMTP Integrator charm."""

diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,2 +1,2 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for charm tests."""

diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py
@@ -1,2 +1,2 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
diff --git a/tests/integration/any_charm.py b/tests/integration/any_charm.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 # pylint: disable=import-error,consider-using-with,no-member

diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for the SMTP Integrator charm integration tests."""

diff --git a/tests/integration/test_charm.py b/tests/integration/test_charm.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """SMTP Integrator charm integration tests."""

diff --git a/tests/interface/__init__.py b/tests/interface/__init__.py
@@ -1,2 +1,2 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
diff --git a/tests/interface/conftest.py b/tests/interface/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for charm-relation-interfaces tests."""

diff --git a/tests/interface/test_smtp.py b/tests/interface/test_smtp.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """SMTP interface tests."""

diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py
@@ -1,2 +1,2 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Unit tests."""

diff --git a/tests/unit/test_charm_state.py b/tests/unit/test_charm_state.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """CharmState unit tests."""

diff --git a/tests/unit/test_library_smtp.py b/tests/unit/test_library_smtp.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """SMTP library unit tests"""

diff --git a/tox.ini b/tox.ini
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 [tox]