Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/jsnjack/hugo-changelog-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaxim Tsoy <maks.tsoy@gmail.com>2019-05-06 18:38:11 +0300
committerMaxim Tsoy <maks.tsoy@gmail.com>2019-05-06 18:38:11 +0300
commitb00c78013c5f94fd6f085ab29146a1d596b4a67b (patch)
tree0d7f9410e0539605833dbbb174679865df39579f
parent6c26b2f50e7d6caba54f11e43ec1227762f8efaa (diff)
Update docs
-rw-r--r--Makefile3
-rw-r--r--README.md11
-rw-r--r--exampleSite/content/deprecated/depr.md11
3 files changed, 24 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 4fecf2a..cd6b572 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,9 @@
change: init_githooks
cd site/changelog && hugo new experimental/`shuf -i 10000-60000 -n 1`.md
+deprecation: init_githooks
+ cd site/changelog && hugo new deprecated/`shuf -i 10000-60000 -n 1`.md
+
release_create:
python release.py
diff --git a/README.md b/README.md
index 239e5bd..e7172c8 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ A [Hugo](https://gohugo.io/) theme to display a changelog
## Conventions
- Create non-released entries in `experimental/` folder. All of them are displayed in the top of the first page
+ - Create deprecation entries in `deprecated/` folder. Deprecated entries appear in a dropdown section on top of the first page
- Create released entries in `released/` folders. Entries are sorted by Weight. Weight is displayed as version
- Your hugo changelog website is located in `site/changelog/` folder
- You are using `master` branch as the stable branch and `develop` branch as a working branch (needed for the post-merge webhook only)
@@ -41,7 +42,15 @@ A [Hugo](https://gohugo.io/) theme to display a changelog
```
The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/experimental/` folder
- 2. The developer updates created file with changes. Changes are going to be rendered in the `experimental` section of the template
+ 1a. If necessary, the developer creates a deprecation entry:
+ ```bash
+ make deprecation
+ ```
+ The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/deprecated/` folder.
+ Note that deprecation entries are not removed automatically. When a certain deprecated feature reaches the end of life period, the corresponding file in the `deprecation/`
+ folder has to be removed manually
+
+ 2. The developer updates created files with changes. Changes are going to be rendered in the `experimental` section of the template
3. Preview the site with the command:
```bash
diff --git a/exampleSite/content/deprecated/depr.md b/exampleSite/content/deprecated/depr.md
new file mode 100644
index 0000000..3fee32e
--- /dev/null
+++ b/exampleSite/content/deprecated/depr.md
@@ -0,0 +1,11 @@
+---
+title:
+subtitle: created on {{ now.Format "2006-01-02" }}
+date: 2018-09-02T20:46:47+02:00
+removal_date: 2019-07-01
+weight:
+version:
+draft: true
+---
+
+Feature X will be removed