Skip to content

Commit

Permalink
Update outdated documentation (#3906)
Browse files Browse the repository at this point in the history
- The virtual office hours now take place bi-weekly.
- Our release note is now a part of the web site.
  - We have to publish the web site before updating the GitHub release page.
- `openzipkin-contrib/zipkin-armeria-example` doesn't exist anymore.
  - Update `TechEmpower/FrameworkBenchmarks` instead.
- Concatenate the shell commands with `&& \` so that it's safer to copy-and-paste.
  • Loading branch information
trustin committed Oct 29, 2021
1 parent 2d2032d commit de88d77
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 19 deletions.
36 changes: 19 additions & 17 deletions .post-release-msg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
1. Upload the artifacts to the staging repository and prepare the web site:

git checkout ${tag}
git checkout ${tag} && \
./gradlew --no-daemon clean publish site

2. Close and release the staging repository at:
Expand All @@ -11,27 +11,29 @@

https://github.com/line/armeria/milestones

4. Update the release note at:
4. Copy the generated web site to the 'gh-pages' branch, e.g.

https://github.com/line/armeria/releases/tag/${tag}
cd ../site-armeria && \
git checkout gh-pages && \
rm -fr .buildinfo .doctrees .gradle * && \
rsync -aiP ../upstream-armeria/site/public/ . && \
git add -A . && \
git commit --amend -m 'Deploy the web site' && \
git push --force

5. Copy the web site generated to the 'gh-pages' branch, e.g.
5. Update the release note at:

cd ../site-armeria
git checkout gh-pages
rm -fr .buildinfo .doctrees .gradle *
rsync -aiP ../upstream-armeria/site/public/ .
git add -A .
git commit --amend -m 'Deploy the web site'
git push --force
https://github.com/line/armeria/releases/tag/${tag}

6. Copy the examples to armeria-examples using the script:

cd ../armeria-examples
./update-examples.sh ${releaseVersion} ../upstream-armeria
git add -A .
git commit -m 'Update Armeria to ${releaseVersion}'
cd ../armeria-examples && \
./update-examples.sh ${releaseVersion} ../upstream-armeria && \
git add -A . && \
git commit -m 'Update Armeria to ${releaseVersion}' && \
git push

7. Send an update pull request to openzipkin-contrib/zipkin-armeria-example
8. Announce the release via Twitter.
7. Announce the release via Twitter.

8. Send an update pull request to https://github.com/TechEmpower/FrameworkBenchmarks
if we made performance improvements.
4 changes: 2 additions & 2 deletions site/src/pages/community/office-hours.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Virtual office hours

Armeria virtual office hours are informal Google Meet sessions anyone can join twice a week to talk about
Armeria virtual office hours are informal Google Meet sessions anyone can join bi-weekly to talk about
any topics related with Armeria, including but not limited to:

* Questions
Expand Down Expand Up @@ -30,7 +30,7 @@ any topics related with Armeria, including but not limited to:

## Calendar

Armeria virtual office hours take place twice a week to cover different time zones:
Armeria virtual office hours take place with alternating schedules to cover different time zones:

<p>
<iframe
Expand Down

0 comments on commit de88d77

Please sign in to comment.