This is an automated email from the ASF dual-hosted git repository.
bdelacretaz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-site.git
The following commit(s) were added to refs/heads/master by this push:
new 20e54d2 Deprecating Sling Modules development page added
20e54d2 is described below
commit 20e54d2d4c67efbe863e987e3a7b5f08abb57521
Author: Bertrand Delacretaz <[email protected]>
AuthorDate: Fri Jan 10 11:55:36 2020 +0100
Deprecating Sling Modules development page added
---
.../jbake/content/documentation/development.md | 1 +
.../development/deprecating-sling-modules.md | 40 ++++++++++++++++++++++
2 files changed, 41 insertions(+)
diff --git a/src/main/jbake/content/documentation/development.md
b/src/main/jbake/content/documentation/development.md
index 9a2198e..92f2807 100644
--- a/src/main/jbake/content/documentation/development.md
+++ b/src/main/jbake/content/documentation/development.md
@@ -57,5 +57,6 @@ Last but not least, here is some more information on how we
ourselves are workin
* [Version Policy](/documentation/development/version-policy.html)
* [Issue Tracker](/documentation/development/issue-tracker.html)
* [Release Management](/documentation/development/release-management.html)
+* [Deprecating Sling
Modules](/documentation/development/deprecating-sling-modules.html)
* [Maven Usage](/documentation/development/maven-usage.html)
* To run our integration tests suite see the [launchpad/testing module
README](https://github.com/apache/sling-org-apache-sling-launchpad-testing/blob/master/README.md)
and the [launchpad/integration-tests
README](https://github.com/apache/sling-org-apache-sling-launchpad-integration-tests/blob/master/README.md)
for how to run individual integration tests. We use the
[sling-IT](https://issues.apache.org/jira/issues/?jql=labels%20%3D%20sling-IT)
label in JIRA for known issues with our int [...]
diff --git
a/src/main/jbake/content/documentation/development/deprecating-sling-modules.md
b/src/main/jbake/content/documentation/development/deprecating-sling-modules.md
new file mode 100644
index 0000000..bd7a887
--- /dev/null
+++
b/src/main/jbake/content/documentation/development/deprecating-sling-modules.md
@@ -0,0 +1,40 @@
+title=Deprecating Sling Modules
+type=page
+status=published
+tableOfContents=false
+tags=development,pmc,deprecation,github
+~~~~~~
+
+The following procedure is recommended to deprecate Sling Git repositories,
indicating that they
+should no longer be used.
+
+ * Create a branch named `maintenance` with the last version before
deprecation.
+ * Empty the `master` branch, keeping just `README.md` file.
+ * Add the `deprecated` GitHub topic to the module, using a
[.asf.yaml](https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories)
file in the `master` branch.
+
+Deprecated modules can then be found with a GitHub query, see below.
+
+The reasoning is that keeping just a `README` file makes it obvious that the
repository is deprecated, and having the `maintenance` branch makes
+it easy to get the deprecated code and even make maintenance releases if
desired.
+
+A deprecated module can be un-deprecated if the Sling PMC agrees to do that,
technically it just means reverting the changes made by this procedure.
+
+## README file contents for deprecated repositories
+
+The `README` file should contain:
+
+ * The Sling logo.
+ * A link to [sling.apache.org](https://sling.apache.org).
+ * The module name with the _(deprecated)_ mention.
+ * A link to the replacement module(s) if any.
+ * A mention of the `maintenance` branch, optionally with a link to it, but
make sure that link is correct if copying
+the `README` from another module.
+
+For examples, see the list of deprecated repositories below.
+
+## See Also
+
+ * [List of deprecated Sling
repositories](https://github.com/search?q=topic%3Asling+topic%3Adeprecated+org%3Aapache)
based on a GitHub query.
+ * [Using Git with Sling boilerplate
files](https://cwiki.apache.org/confluence/display/SLING/Using+Git+with+Sling#UsingGitwithSling-Boilerplatefiles).
+ * The previously used [svn
attic](https://svn.apache.org/repos/asf/sling/attic/) is where older deprecated
modules are found.
+
