You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by rl...@apache.org on 2022/07/17 18:07:14 UTC

[celix-site] 01/02: Describe that creating a per-release docs.md file is still something manually

This is an automated email from the ASF dual-hosted git repository.

rlenferink pushed a commit to branch improve-release-steps
in repository https://gitbox.apache.org/repos/asf/celix-site.git

commit fcb01a8d9c0e304f0b34847b475787d1ce62fe95
Author: Roy Lenferink <le...@gmail.com>
AuthorDate: Sun Jul 17 19:44:47 2022 +0200

    Describe that creating a per-release docs.md file is still something manually
---
 source/contributing/releasing.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/source/contributing/releasing.md b/source/contributing/releasing.md
index a025b85..04cb9ed 100644
--- a/source/contributing/releasing.md
+++ b/source/contributing/releasing.md
@@ -283,6 +283,8 @@ by updating the [header.html]({{< site_src "layouts/partials/header.html" >}}) a
 * Run the [extract_celix_docs.sh]({{< site_src "extract_celix_docs.sh" >}}) script to copy the markdown documentation within the Celix code base
 to the website.
 * Verify whether the documentation is correctly copied & otherwise make some minor tweaks.
+* Create a `docs.md` file within the release documentation directory (example path: `source/docs/2.2.1/docs.md`, where 2.2.1 needs to be
+  substituted with the actual released version). This file can be copied and updated from e.g. a previous release.
 * Check-in the documentation and create a pull request to the [celix-site]({{< param "siteRepositoryUrl" >}}) repository for the Celix team to review.
 
 Once the site is updated proceed with announcing the release.