hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Hadoop Wiki] Update of "HowToRelease" by MartonElek
Date Fri, 26 Oct 2018 10:19:40 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Hadoop Wiki" for change notification.

The "HowToRelease" page has been changed by MartonElek:

Update site generation part.

    1. effect the release of artifacts by selecting the staged repository and then clicking
    1. If there were multiple RCs, simply drop the staging repositories corresponding to failed
   1. Wait 24 hours for release to propagate to mirrors.
-  1. Edit the website.
+  1. Edit the website (Generic docs about the new website generation can be found [[[https://cwiki.apache.org/confluence/display/HADOOP/How+to+generate+and+push+ASF+web+site+after+HADOOP-14163|here]])
    1. Checkout the website if you haven't already
- svn co https://svn.apache.org/repos/asf/hadoop/common/site/main hadoop-common-site
+ git clone https://gitbox.apache.org/repos/asf/hadoop-site.git -b asf-site
- }}}
+   }}}
-   1. Update the documentation links in {{{author/src/documentation/content/xdocs/site.xml}}}.
-   1. Update the release news in {{{author/src/documentation/content/xdocs/releases.xml}}}.
-   1. Update the news on the home page {{{author/src/documentation/content/xdocs/index.xml}}}.
+   1. [[https://gohugo.io/getting-started/installing/|Install hugo]] if you haven't already
((tldr; apt-get install/pacman -S/brew install hugo)) 
+   1. Create the new release announcement
+   {{{
+ cat << EOF > src/release/${VERSION}.md
+ ---
+ title: Release ${VERSION} available
+ date: 201X-XX-XX
+ linked: true
+ ---
+ <!---
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License. See accompanying LICENSE file.
+ -->
+ This is the first stable release of Apache Hadoop TODO line. It contains TODO bug fixes,
improvements and enhancements since TODO.
+ Users are encouraged to read the [overview of major changes][1] since TODO.
+ For details of 435 bug fixes, improvements, and other enhancements since the previous TODO
+ please check [release notes][2] and [changelog][3] 
+  detail the changes since TODO.
+ [1]: /docs/r${VERSION}/index.html
+ [2]: http://hadoop.apache.org/docs/r${VERSION}/hadoop-project-dist/hadoop-common/release/${VERSION}/RELEASENOTES.${VERSION}.html
+ [3]: http://hadoop.apache.org/docs/r${VERSION}/hadoop-project-dist/hadoop-common/release/${VERSION}/CHANGES.${VERSION}.html
+   }}} 
+   1. Note: update all the TODO + the date. '''Don't use date from the future''', it won't
be rendered.
+   1. Remove the {{{linked: true}}} line from the previous release file, eg. from src/release/3.0.0.md.
Docs/downloads of the releases with {{{linked:true}}} will be linked from the menu.
-   1. Copy the new release docs to svn and update the {{{docs/current}}} link, by doing the
+   1. add the docs and update the {{{content/docs/current}}} link, by doing the following:
- cd publish/docs
+ cd content/docs
  tar xvf /path/to/hadoop-${version}-site.tar.gz
  # Update current2, current, stable and stable2 as needed.
  # For example
@@ -191, +226 @@

  ln -s current2 current
    1. Similarly update the symlinks for stable if need be.
-   1. Add the documentation changes.
+   1. Check the rendering of the new site: {{{hugo serve && firefox http://localhost:1313}}}
+   1. Regenerate the site, review it, then commit it per the instructions in HowToCommit.
(The generated HTML files also should be committed. Both src and the rendered site are in
the same repo.)
+ hugo
+ git add .
+ git commit
+ git push
- svn add publish/docs/r${version}
- }}}
-   1. Regenerate the site, review it, then commit it per the instructions in HowToCommit.
-   {{{
- <run Forrest>
- <preview changes>
- svn commit -m "Updated site for release X.Y.Z."
   1. Send announcements to the user and developer lists once the site changes are visible.
   1. --(In JIRA, close issues resolved in the release.  Disable mail notifications for this
bulk change.)-- Recommend '''not''' closing, since it prevents JIRAs from being edited and
makes it more difficult to track backports.

To unsubscribe, e-mail: common-commits-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-commits-help@hadoop.apache.org

View raw message