You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fluo.apache.org by ct...@apache.org on 2020/08/14 00:12:48 UTC
[fluo-website] branch main updated: Update site for main branch and
auto site build (#195)
This is an automated email from the ASF dual-hosted git repository.
ctubbsii pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fluo-website.git
The following commit(s) were added to refs/heads/main by this push:
new 23d5593 Update site for main branch and auto site build (#195)
23d5593 is described below
commit 23d55934ceaf436b5093b55ed5cdfc7d486cf2f9
Author: Christopher Tubbs <ct...@apache.org>
AuthorDate: Thu Aug 13 20:12:40 2020 -0400
Update site for main branch and auto site build (#195)
* Update links and references from the master branch to main
* Add .asf.yaml with configuration to automatically stage the site
* Update instructions for contributing and testing the site build
* Remove post-commit hook for locally updating asf-site
---
.asf.yaml | 24 ++++++++
CONTRIBUTING.md | 81 +++++++++++++++++++++-----
README.md | 65 +++++++++++++--------
_config.yml | 6 +-
_fluo-1-2/administration/initialize.md | 2 +-
_fluo-1-2/administration/run-fluo-in-docker.md | 2 +-
_fluo-1-2/administration/run-fluo-in-yarn.md | 2 +-
_fluo-1-2/getting-started/install-fluo.md | 2 +-
_layouts/fluo-1.2.html | 4 +-
_layouts/recipes-1.2.html | 2 +-
_posts/blog/2016-12-22-spark-load.md | 2 +-
_recipes-1-2/recipes/combine-queue.md | 2 +-
_recipes-1-2/recipes/row-hasher.md | 2 +-
_scripts/git-hooks/post-commit | 55 -----------------
docs/fluo-recipes/1.1.0-incubating/index.md | 4 +-
docs/fluo/1.0.0-beta-1/mini-fluo-setup.md | 2 +-
docs/fluo/1.0.0-beta-1/prod-fluo-setup.md | 4 +-
docs/fluo/1.0.0-beta-2/mini-fluo-setup.md | 2 +-
docs/fluo/1.0.0-beta-2/prod-fluo-setup.md | 4 +-
docs/fluo/1.0.0-incubating/install.md | 2 +-
docs/fluo/1.1.0-incubating/index.md | 4 +-
docs/fluo/1.1.0-incubating/install.md | 2 +-
pages/how-to-contribute.md | 12 ++--
pages/related-projects.md | 6 +-
pages/release-process.md | 16 ++---
25 files changed, 173 insertions(+), 136 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 0000000..0c295bd
--- /dev/null
+++ b/.asf.yaml
@@ -0,0 +1,24 @@
+
+staging:
+ profile: ~
+ whoami: asf-staging
+
+publish:
+ whoami: asf-site
+
+github:
+ description: "Apache Fluo Website"
+ homepage: https://fluo.apache.org/
+ labels:
+ - fluo
+ - big-data
+ - asf-site
+ features:
+ wiki: false
+ issues: true
+ projects: true
+
+jekyll:
+ whoami: main
+ target: asf-staging
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b43c9e9..4e025de 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -20,29 +20,78 @@ limitations under the License.
Contributions to the website can be made by submitting pull requests to this repo. Checkout [How to
Contribute][contribute] on for general instructions on contributing to Fluo projects.
-# Testing locally
+## Local Builds for Testing
-If you want to view your changes in your browser before submitting a pull request, you will need
-install all of the gems in the [Gemfile] to serve the website in your browser using [Jekyll]. This
-can be done by following these instructions:
+### Setting up Your Jekyll/Bundler Environment
-1. After you have Ruby and RubyGems installed on your machine, install [Bundler]:
+Ruby and RubyGems are required to use Jekyll and Bundler, so first make sure
+you have those on your machine.
- gem install bundler
+If you are using an OS packaged version of Ruby, you may also need to install
+the ruby-dev (Ubuntu) or ruby-devel (Fedora) package as well to build any
+native code for gems that are installed later. Installing these will also
+ensure your system's RubyGems package is installed. Depending on your OS, you
+may also need other packages to install/build gems, such as ruby-full, make,
+gcc, nodejs, build-essentials, or patch.
-2. Use [Bundler] to install all gems in the [Gemfile] of this repo.
+Once Ruby, RubyGems, and any necessary native tools are installed, you are
+ready to install [Bundler] to manage the remaining RubyGem dependencies.
+Bundler is included in Ruby 2.6 and later as a default gem, so installing it
+may not be needed.
- cd fluo-website/
- bundle install
+Because we use [Bundler] to install specific versions of gems, it is not
+recommended to use an OS packaged version of gems other than what comes
+built-in. If you are using an OS packaged version of Ruby, it is __strongly__
+recommended to avoid `sudo` when installing additional gems, in order to avoid
+conflicting with your system's package-managed installation. Instead, you can
+specify a `GEM_HOME` directory for installing gems locally in your home
+directory. You can do this in your `$HOME/.bashrc` file or other appropriate
+place for your environment:
-3. Run the following command to have Jekyll serve the website locally:
+```bash
+# in .bashrc
+export GEM_HOME=$HOME/.gem/ruby
+```
- bundle exec jekyll serve --watch
+With Ruby installed on your machine, you can install [Bundler] using the
+command below:
-4. Open your web browser to [http://localhost:4000](http://localhost:4000).
+```bash
+# not necessary in Ruby >2.6, since it is a default gem since 2.6
+gem install bundler
+```
-[contribute]: https://fluo.apache.org/how-to-contribute/
-[Jekyll]: https://jekyllrb.com/
-[Bundler]: https://bundler.io/
-[Gemfile]: Gemfile
+Next, use [Bundler] to install [Jekyll] and other dependencies needed to run
+the website (this command assumes your current working directory is your clone
+of this repository with the `main` branch checked out, because that's where
+the Gemfile dependency list exists).
+
+```bash
+bundle install
+```
+
+### Testing with the Built-in Jekyll Webserver
+
+The command to serve the site contents using Jekyll's built-in webserver is as
+follows (this webserver may behave differently than apache.org's servers).
+
+```bash
+bundle exec jekyll serve -w
+```
+You do __NOT__ need to execute a `bundle exec jekyll build` command first, as
+the `serve` command is sufficient to both build the site and serve its
+contents. By default, it will also try to re-build any pages you change while
+running the webserver, which can be quite useful if trying to get some CSS or
+HTML styled "just right".
+
+Jekyll will print a local URL where the site can be viewed (usually,
+[http://0.0.0.0:4000/](http://0.0.0.0:4000/)).
+
+
+[Bundler]: https://bundler.io/
+[Jekyll]: https://jekyllrb.com/
+[contribute]: https://fluo.apache.org/how-to-contribute/
+[kramdown]: https://kramdown.gettalong.org/
+[production]: https://fluo.apache.org
+[staging]: https://fluo.staged.apache.org
diff --git a/README.md b/README.md
index 7f967f6..d106058 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Apache Fluo website
-Code powering the Apache Fluo website ([https://fluo.apache.org](https://fluo.apache.org)).
+Code powering the Apache Fluo website ([https://fluo.apache.org][production]).
[Contributing](CONTRIBUTING.md) describes how to test locally.
## Update website for new release
@@ -45,32 +45,51 @@ replace any reference to `fluo` with `recipes`.
3. Update `_config.yml` by adding a `fluo-1-3` collection and setting default values for it.
You may want to keep 1.2 values for github & javadocs until 1.3 is released.
-## Committer instructions
+## Publishing
-To publish Fluo's website the `gh-pages` branch must be rendered into the `asf-site`
-branch. The script `_scripts/git-hooks/post-commit` automates rendering into the `asf-site` branch.
-The commands below serve as a guide for committers who wish to publish the web site.
+### Automatic Staging
+
+Changes pushed to our `main` branch will automatically trigger [Jekyll] to
+build our site from that branch and push the result to our `asf-staging`
+branch, where they will be served on [our default staging site][staging].
+
+### Publishing Staging to Production
+
+First, add our repository as a remote in your local clone, if you haven't
+already done so (these commands assume the name of that remote is 'upstream').
+
+Example:
```bash
- # ensure local asf-site branch is up to date
- git checkout asf-site
- git pull upstream asf-site
-
- # switch to gh-pages branch, update it, and build new site
- git checkout gh-pages
- git pull upstream gh-pages
- ./_scripts/git-hooks/post-commit
-
- # switch to asf-site, look at the commit created by post-commit script, and push it if ok
- git checkout asf-site
- git log -p
- git push upstream asf-site
+git clone https://github.com/<yourusername>/fluo-website
+cd fluo-website
+git remote add upstream https://github.com/apache/fluo-website
```
-In the commands above `upstream` is
+Next, publish the staging site to production by updating the `asf-site` branch
+to match the contents in the `asf-staging` branch:
+```bash
+# Step 0: stay in main branch; you never need to switch
+git checkout main
+
+# Step 1: update your upstream remote
+git remote update upstream
+
+# Step 2: push upstream/asf-staging to upstream/asf-site
+# run next command with --dry-run first to see what it will do without making changes
+git push upstream upstream/asf-staging:asf-site
```
-$ git remote -v | grep upstream
-upstream https://gitbox.apache.org/repos/asf/fluo-website/ (fetch)
-upstream https://gitbox.apache.org/repos/asf/fluo-website/ (push)``
-```
+
+Note that Step 3 should always be a fast-forward merge. That is, there should
+never be any reason to force-push it if everything is done correctly. If extra
+commits are ever added to `asf-site` that are not present in `asf-staging`,
+then those branches will need to be sync'd back up in order to continue
+avoiding force pushes.
+
+The final site can be viewed [here][production].
+
+
+[Jekyll]: https://jekyllrb.com/
+[production]: https://fluo.apache.org
+[staging]: https://fluo.staged.apache.org
diff --git a/_config.yml b/_config.yml
index ece282f..0433578 100644
--- a/_config.yml
+++ b/_config.yml
@@ -59,8 +59,8 @@ defaults:
minor_release: "1.2"
docs_base: "/docs/fluo/1.2"
javadoc_base: "https://static.javadoc.io/org.apache.fluo/fluo-api/1.2.0"
- github_base: "https://github.com/apache/fluo/blob/master"
- github_yarn: "https://github.com/apache/fluo-yarn/blob/master"
+ github_base: "https://github.com/apache/fluo/blob/main"
+ github_yarn: "https://github.com/apache/fluo-yarn/blob/main"
-
scope:
path: "_recipes-1-2"
@@ -71,7 +71,7 @@ defaults:
version: "1.2.0"
minor_release: "1.2"
docs_base: "/docs/fluo-recipes/1.2"
- github_base: "https://github.com/apache/fluo-recipes/blob/master"
+ github_base: "https://github.com/apache/fluo-recipes/blob/main"
javadoc_fluo: "https://static.javadoc.io/org.apache.fluo/fluo-api/1.1.0-incubating"
javadoc_core: "https://static.javadoc.io/org.apache.fluo/fluo-recipes-core/1.1.0-incubating"
javadoc_accumulo: "https://static.javadoc.io/org.apache.fluo/fluo-recipes-accumulo/1.1.0-incubating"
diff --git a/_fluo-1-2/administration/initialize.md b/_fluo-1-2/administration/initialize.md
index fcc94fd..d9e0124 100644
--- a/_fluo-1-2/administration/initialize.md
+++ b/_fluo-1-2/administration/initialize.md
@@ -74,7 +74,7 @@ Also, learn how to [manage Fluo applications][manage].
[fluo-app.properties]: {{ page.github_base}}/modules/distribution/src/main/config/fluo-app.properties
[fluo-conn.properties]: {{ page.github_base}}/modules/distribution/src/main/config/fluo-conn.properties
-[phrasecount]: https://github.com/apache/fluo-examples/tree/master/phrasecount
+[phrasecount]: https://github.com/apache/fluo-examples/tree/main/phrasecount
[process]: {{ page.docs_base }}/administration/run-fluo-processes
[yarn]: {{ page.docs_base }}/administration/run-fluo-in-yarn
[docker]: {{ page.docs_base }}/administration/run-fluo-in-docker
diff --git a/_fluo-1-2/administration/run-fluo-in-docker.md b/_fluo-1-2/administration/run-fluo-in-docker.md
index 8c1b09d..df53a49 100644
--- a/_fluo-1-2/administration/run-fluo-in-docker.md
+++ b/_fluo-1-2/administration/run-fluo-in-docker.md
@@ -138,7 +138,7 @@ Learn how to [manage Fluo applications][manage].
[DockerHub]: https://hub.docker.com/
[fluo-dockerhub]: https://hub.docker.com/r/apache/fluo/
-[build-image]: https://github.com/apache/fluo-docker/blob/master/README.md#build-the-docker-image
+[build-image]: https://github.com/apache/fluo-docker/blob/main/README.md#build-the-docker-image
[manage]: {{ page.docs_base }}/administration/manage-applications
[Fluo]: https://fluo.apache.org/
[Accumulo]: https://accumulo.apache.org/
diff --git a/_fluo-1-2/administration/run-fluo-in-yarn.md b/_fluo-1-2/administration/run-fluo-in-yarn.md
index 66088ce..328f67b 100644
--- a/_fluo-1-2/administration/run-fluo-in-yarn.md
+++ b/_fluo-1-2/administration/run-fluo-in-yarn.md
@@ -29,7 +29,7 @@ and worker processes if you are running in YARN.
## Install and Configure Fluo YARN launcher
To install the Fluo YARN launcher, you will need to obtain a distribution tarball. It is recommended that you
-download the [latest release]. You can also build a distribution from the master branch by following these steps
+download the [latest release]. You can also build a distribution from the main branch by following these steps
which create a tarball in `distribution/target`:
git clone https://github.com/apache/fluo-yarn.git
diff --git a/_fluo-1-2/getting-started/install-fluo.md b/_fluo-1-2/getting-started/install-fluo.md
index 2872dbc..48e1919 100644
--- a/_fluo-1-2/getting-started/install-fluo.md
+++ b/_fluo-1-2/getting-started/install-fluo.md
@@ -23,7 +23,7 @@ or cluster:
## Obtain a distribution
Before you can install Fluo, you will need to obtain a distribution tarball. It is recommended that
-you download the [latest release]. You can also build a distribution from the master branch by following
+you download the [latest release]. You can also build a distribution from the main branch by following
these steps which create a tarball in `modules/distribution/target`:
git clone https://github.com/apache/fluo.git
diff --git a/_layouts/fluo-1.2.html b/_layouts/fluo-1.2.html
index ff39d6f..6fd838f 100644
--- a/_layouts/fluo-1.2.html
+++ b/_layouts/fluo-1.2.html
@@ -42,14 +42,14 @@ layout: default
{% unless page.nodoctitle %}
<div class="row">
<div class="col-md-10"><h1>{{ page.title }}</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/main/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
{% endunless %}
{{ content }}
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="{{ site.baseurl }}/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/main/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/_layouts/recipes-1.2.html b/_layouts/recipes-1.2.html
index c9b0310..eebf952 100644
--- a/_layouts/recipes-1.2.html
+++ b/_layouts/recipes-1.2.html
@@ -42,7 +42,7 @@ layout: default
{% unless page.nodoctitle %}
<div class="row">
<div class="col-md-10"><h1>{{ page.title }}</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/main/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
{% endunless %}
{{ content }}
diff --git a/_posts/blog/2016-12-22-spark-load.md b/_posts/blog/2016-12-22-spark-load.md
index 899f215..582835b 100644
--- a/_posts/blog/2016-12-22-spark-load.md
+++ b/_posts/blog/2016-12-22-spark-load.md
@@ -242,5 +242,5 @@ implications of early vs late binding is something to consider.
[bulk_readme]: http://accumulo.apache.org/1.8/examples/bulkIngest
[bulk_code]: https://github.com/apache/accumulo/tree/rel/1.8.0/examples/simple/src/main/java/org/apache/accumulo/examples/simple/mapreduce/bulk
[AccumuloRangePartitioner]: https://github.com/apache/incubator-fluo-recipes/blob/rel/fluo-recipes-1.0.0-incubating/modules/spark/src/main/java/org/apache/fluo/recipes/spark/AccumuloRangePartitioner.java
-[Webindex]: https://github.com/apache/fluo-examples/tree/master/webindex
+[Webindex]: https://github.com/apache/fluo-examples/tree/main/webindex
[spark]: https://spark.apache.org
diff --git a/_recipes-1-2/recipes/combine-queue.md b/_recipes-1-2/recipes/combine-queue.md
index 37d9dc9..ca8bb79 100644
--- a/_recipes-1-2/recipes/combine-queue.md
+++ b/_recipes-1-2/recipes/combine-queue.md
@@ -204,7 +204,7 @@ calls `process()` on a [ChangeObserver].
* The old value will always be what was reported as the new value in the
previous transaction that called `ChangeObserver.process()`.
-[phrasecount]: https://github.com/apache/fluo-examples/tree/master/phrasecount
+[phrasecount]: https://github.com/apache/fluo-examples/tree/main/phrasecount
[CombineQueue]: {{ page.javadoc_core }}/org/apache/fluo/recipes/core/combine/CombineQueue.html
[ChangeObserver]: {{ page.javadoc_core }}/org/apache/fluo/recipes/core/combine/ChangeObserver.html
[Combiner]: {{ page.javadoc_core }}/org/apache/fluo/recipes/core/combine/Combiner.html
diff --git a/_recipes-1-2/recipes/row-hasher.md b/_recipes-1-2/recipes/row-hasher.md
index 5e0841a..05480fe 100644
--- a/_recipes-1-2/recipes/row-hasher.md
+++ b/_recipes-1-2/recipes/row-hasher.md
@@ -117,5 +117,5 @@ Balancing config will spread the tablets evenly across the tablet servers,
which will spread the computation evenly. See the [table optimizations][2]
documentation for information on how to apply the optimizations.
-[1]: https://github.com/apache/fluo-examples/tree/master/webindex
+[1]: https://github.com/apache/fluo-examples/tree/main/webindex
[2]: {{ page.docs_base }}/tools/table-optimization/
diff --git a/_scripts/git-hooks/post-commit b/_scripts/git-hooks/post-commit
deleted file mode 100755
index 5427efe..0000000
--- a/_scripts/git-hooks/post-commit
+++ /dev/null
@@ -1,55 +0,0 @@
-#! /usr/bin/env bash
-
-build_jekyll_site() {
- # $1 is the expected source branch
- local source_br; source_br=$1
- # $2 is the name of the target branch
- local tgt_br; tgt_br=$2
-
- local cur_branch; cur_branch=$(git rev-parse --symbolic-full-name HEAD) || return 1
-
- # skip execution on other branches
- [[ $cur_branch == "refs/heads/$source_br" ]] || return 0
-
- # create message
- local message; message="Jekyll build from $source_br:$(git rev-parse --verify 'HEAD^{commit}' | cut -c1-7)"$'\n'$'\n'"$(git cat-file commit HEAD | sed '1,/^$/d')"
-
- # import git utils: needed for die, require_clean_work_tree
- . "$(git --exec-path)/git-sh-setup" || return 1
-
- # ensure target branch exists
- local target_branch; target_branch=$(git rev-parse --symbolic-full-name "$tgt_br" 2>/dev/null) || die "fatal: $tgt_br is not a branch"
- case "$target_branch" in
- refs/heads/*)
- true
- ;;
- *)
- die "fatal: $tgt_br is not a branch"
- ;;
- esac
-
- # don't build what's not checked in
- require_clean_work_tree
-
- # check gem versions
- bundle check >/dev/null || die "fatal: gems are out of date; run 'bundle install'"
-
- # prep the working location
- local workdir; workdir=$(mktemp -d /tmp/jekyll-XXXXXXXXXX) || die "fatal: unable to allocate a temporary directory"
- trap "rm -rf '""$workdir""'" 0 1 2 3 15
-
- # actually generate the site
- bundle exec jekyll build --destination "$workdir/_site" --safe || die "fatal: jekyll build failure"
-
- # prepare and commit to the target branch
- export GIT_INDEX_FILE="$workdir/index"
- rm -f "$workdir/_site/Gemfile" "$workdir/_site/Gemfile.lock"
- git --work-tree="$workdir/_site" add . || die "fatal: error adding $workdir/_site"
- local tree; tree=$(git write-tree) || die "fatal: error writing tree"
- local commit; commit=$(git commit-tree "$tree" -p "$target_branch" -m "$message") || die "fatal: error writing commit"
- git update-ref -m "$message" "$target_branch" "$commit" || die "fatal: error updating ref"
-
- return 0
-}
-
-build_jekyll_site 'gh-pages' 'asf-site'
diff --git a/docs/fluo-recipes/1.1.0-incubating/index.md b/docs/fluo-recipes/1.1.0-incubating/index.md
index bec214c..350a929 100644
--- a/docs/fluo-recipes/1.1.0-incubating/index.md
+++ b/docs/fluo-recipes/1.1.0-incubating/index.md
@@ -97,7 +97,7 @@ Below is a sample Maven POM containing all possible Fluo Recipes dependencies:
[row-hasher]: /docs/fluo-recipes/1.1.0-incubating/row-hasher/
[spark]: /docs/fluo-recipes/1.1.0-incubating/spark/
[testing]: /docs/fluo-recipes/1.1.0-incubating/testing/
-[ti]: https://travis-ci.org/apache/incubator-fluo-recipes.svg?branch=master
+[ti]: https://travis-ci.org/apache/incubator-fluo-recipes.svg?branch=main
[tl]: https://travis-ci.org/apache/incubator-fluo-recipes
[li]: http://img.shields.io/badge/license-ASL-blue.svg
-[ll]: https://github.com/apache/incubator-fluo-recipes/blob/master/LICENSE
+[ll]: https://github.com/apache/incubator-fluo-recipes/blob/main/LICENSE
diff --git a/docs/fluo/1.0.0-beta-1/mini-fluo-setup.md b/docs/fluo/1.0.0-beta-1/mini-fluo-setup.md
index ac8d6f9..82f0c74 100644
--- a/docs/fluo/1.0.0-beta-1/mini-fluo-setup.md
+++ b/docs/fluo/1.0.0-beta-1/mini-fluo-setup.md
@@ -25,7 +25,7 @@ First, clone Fluo:
git clone https://github.com/fluo-io/fluo.git
cd fluo/
-Optionally, check out a stable tag (if you don't want to build a release from master):
+Optionally, check out a stable tag (if you don't want to build a release from main):
git checkout 1.0.0-beta-1
diff --git a/docs/fluo/1.0.0-beta-1/prod-fluo-setup.md b/docs/fluo/1.0.0-beta-1/prod-fluo-setup.md
index 2811a6a..9dd0c55 100644
--- a/docs/fluo/1.0.0-beta-1/prod-fluo-setup.md
+++ b/docs/fluo/1.0.0-beta-1/prod-fluo-setup.md
@@ -26,14 +26,14 @@ Before you can install Fluo, you will need to obtain a distribution tarball that
works for your environment. Fluo distributions are built for specific releases
of Hadoop and Accumulo. If you are using Accumulo 1.6.1 and Hadoop 2.3.0,
you can download the [latest release][release]. If you need a release for a
-different environment or one built from the master branch, follow these steps:
+different environment or one built from the main branch, follow these steps:
First, clone Fluo:
git clone https://github.com/fluo-io/fluo.git
cd fluo/
-Optionally, check out a stable tag (if you don't want to build a release from master):
+Optionally, check out a stable tag (if you don't want to build a release from main):
git checkout 1.0.0-beta-1
diff --git a/docs/fluo/1.0.0-beta-2/mini-fluo-setup.md b/docs/fluo/1.0.0-beta-2/mini-fluo-setup.md
index 70f135e..20aed75 100644
--- a/docs/fluo/1.0.0-beta-2/mini-fluo-setup.md
+++ b/docs/fluo/1.0.0-beta-2/mini-fluo-setup.md
@@ -25,7 +25,7 @@ First, clone Fluo:
git clone https://github.com/fluo-io/fluo.git
cd fluo/
-Optionally, check out a stable tag (if you don't want to build a release from master):
+Optionally, check out a stable tag (if you don't want to build a release from main):
git checkout 1.0.0-beta-2
diff --git a/docs/fluo/1.0.0-beta-2/prod-fluo-setup.md b/docs/fluo/1.0.0-beta-2/prod-fluo-setup.md
index d93cf25..8961384 100644
--- a/docs/fluo/1.0.0-beta-2/prod-fluo-setup.md
+++ b/docs/fluo/1.0.0-beta-2/prod-fluo-setup.md
@@ -26,14 +26,14 @@ Before you can install Fluo, you will need to obtain a distribution tarball that
works for your environment. Fluo distributions are built for specific releases
of Hadoop and Accumulo. If you are using Accumulo 1.6.4 and Hadoop 2.6.3,
you can download the [latest release][release]. If you need a release for a
-different environment or one built from the master branch, follow these steps:
+different environment or one built from the main branch, follow these steps:
First, clone Fluo:
git clone https://github.com/fluo-io/fluo.git
cd fluo/
-Optionally, check out a stable tag (if you don't want to build a release from master):
+Optionally, check out a stable tag (if you don't want to build a release from main):
git checkout 1.0.0-beta-2
diff --git a/docs/fluo/1.0.0-incubating/install.md b/docs/fluo/1.0.0-incubating/install.md
index a897529..4567cc8 100644
--- a/docs/fluo/1.0.0-incubating/install.md
+++ b/docs/fluo/1.0.0-incubating/install.md
@@ -23,7 +23,7 @@ or cluster:
## Obtain a distribution
Before you can install Fluo, you will need to obtain a distribution tarball. It is recommended that
-you download the [latest release][release]. You can also build a distribution from the master
+you download the [latest release][release]. You can also build a distribution from the main
branch by following these steps which create a tarball in `modules/distribution/target`:
git clone https://github.com/apache/incubator-fluo.git
diff --git a/docs/fluo/1.1.0-incubating/index.md b/docs/fluo/1.1.0-incubating/index.md
index 18914d7..4b27f58 100644
--- a/docs/fluo/1.1.0-incubating/index.md
+++ b/docs/fluo/1.1.0-incubating/index.md
@@ -47,10 +47,10 @@ Below are helpful resources for Fluo application developers:
[Metrics]: /docs/fluo/1.1.0-incubating/metrics/
[Contributing]: /docs/fluo/1.1.0-incubating/contributing/
[Architecture]: /docs/fluo/1.1.0-incubating/architecture/
-[ti]: https://travis-ci.org/apache/incubator-fluo.svg?branch=master
+[ti]: https://travis-ci.org/apache/incubator-fluo.svg?branch=main
[tl]: https://travis-ci.org/apache/incubator-fluo
[li]: http://img.shields.io/badge/license-ASL-blue.svg
-[ll]: https://github.com/apache/incubator-fluo/blob/master/LICENSE
+[ll]: https://github.com/apache/incubator-fluo/blob/main/LICENSE
[mi]: https://maven-badges.herokuapp.com/maven-central/org.apache.fluo/fluo-api/badge.svg
[ml]: https://maven-badges.herokuapp.com/maven-central/org.apache.fluo/fluo-api/
[ji]: https://javadoc-emblem.rhcloud.com/doc/org.apache.fluo/fluo-api/badge.svg
diff --git a/docs/fluo/1.1.0-incubating/install.md b/docs/fluo/1.1.0-incubating/install.md
index 2b675a8..9d7df38 100644
--- a/docs/fluo/1.1.0-incubating/install.md
+++ b/docs/fluo/1.1.0-incubating/install.md
@@ -22,7 +22,7 @@ or cluster:
## Obtain a distribution
Before you can install Fluo, you will need to obtain a distribution tarball. It is recommended that
-you download the [latest release][release]. You can also build a distribution from the master
+you download the [latest release][release]. You can also build a distribution from the main
branch by following these steps which create a tarball in `modules/distribution/target`:
git clone https://github.com/apache/incubator-fluo.git
diff --git a/pages/how-to-contribute.md b/pages/how-to-contribute.md
index f348186..f197d64 100644
--- a/pages/how-to-contribute.md
+++ b/pages/how-to-contribute.md
@@ -100,12 +100,12 @@ To properly format code in Eclipse :
[ui]: https://github.com/apache/fluo-uno/issues
[mi]: https://github.com/apache/fluo-muchos/issues
[ei]: https://github.com/apache/fluo-examples/issues
-[fc]: https://github.com/apache/fluo/blob/master/CONTRIBUTING.md
-[rc]: https://github.com/apache/fluo-recipes/blob/master/CONTRIBUTING.md
-[wc]: https://github.com/apache/fluo-website/blob/gh-pages/CONTRIBUTING.md
-[yc]: https://github.com/apache/fluo-yarn/blob/master/CONTRIBUTING.md
-[dc]: https://github.com/apache/fluo-docker/blob/master/CONTRIBUTING.md
-[bc]: https://github.com/apache/fluo-bytes/blob/master/CONTRIBUTING.md
+[fc]: https://github.com/apache/fluo/blob/main/CONTRIBUTING.md
+[rc]: https://github.com/apache/fluo-recipes/blob/main/CONTRIBUTING.md
+[wc]: https://github.com/apache/fluo-website/blob/main/CONTRIBUTING.md
+[yc]: https://github.com/apache/fluo-yarn/blob/main/CONTRIBUTING.md
+[dc]: https://github.com/apache/fluo-docker/blob/main/CONTRIBUTING.md
+[bc]: https://github.com/apache/fluo-bytes/blob/main/CONTRIBUTING.md
[tutorial]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
[stackoverflow]: https://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git
[rtc]: https://www.apache.org/foundation/glossary.html#ReviewThenCommit
diff --git a/pages/related-projects.md b/pages/related-projects.md
index 317f4ca..ba00319 100644
--- a/pages/related-projects.md
+++ b/pages/related-projects.md
@@ -31,9 +31,9 @@ list, please open an issue or submit a pull request [on GitHub][web-ghr].
[Fluo Recipes]: https://github.com/apache/fluo-recipes
[Muchos]: https://github.com/apache/fluo-muchos
[Uno]: https://github.com/apache/fluo-uno
-[Webindex]: https://github.com/apache/fluo-examples/tree/master/webindex
-[Stresso]: https://github.com/apache/fluo-examples/tree/master/stresso
-[Phrasecount]: https://github.com/apache/fluo-examples/tree/master/phrasecount
+[Webindex]: https://github.com/apache/fluo-examples/tree/main/webindex
+[Stresso]: https://github.com/apache/fluo-examples/tree/main/stresso
+[Phrasecount]: https://github.com/apache/fluo-examples/tree/main/phrasecount
[Jaccard]: https://github.com/keith-turner/jaccard
[web-ghr]: https://github.com/apache/fluo-website
[Rya]: https://rya.apache.org
diff --git a/pages/release-process.md b/pages/release-process.md
index fe9a121..c25eea7 100644
--- a/pages/release-process.md
+++ b/pages/release-process.md
@@ -54,7 +54,7 @@ In the following steps `RCV` is short for release candidate version. For the ca
make an initial release candidate available for evaluation, but nor for voting, consider using `0`
for `RCV`.
- 1. Branch master (or the current snapshot) and call the branch `<releaseVersion>-rc<RCV>-next`
+ 1. Branch main (or the current snapshot) and call the branch `<releaseVersion>-rc<RCV>-next`
2. Prepare the release which will verify that all tests pass: `mvn release:prepare`
@@ -97,12 +97,12 @@ for `RCV`.
When the vote passes on a release candidate, follow the steps below to complete the release using the chosen RC:
1. Merge your RC branch into the correct branch and push those commits upstream. The example below
- assume `master` is the correct branch. Afterwards, you can delete your RC branch.
+ assume `main` is the correct branch. Afterwards, you can delete your RC branch.
```shell
- git checkout master
+ git checkout main
git merge <releaseVersion>-rc<RCV>-next
- git push apache-remote master
+ git push apache-remote main
```
2. Release the artifacts at https://repository.apache.org so that they get published in Maven
@@ -246,10 +246,10 @@ Below are more projects with integration tests which can be found at - `https://
[Fluo Recipes]: https://github.com/apache/fluo-recipes
[Uno]:https://github.com/apache/fluo-uno
-[Webindex]: https://github.com/apache/fluo-examples/tree/master/webindex
-[Stresso]: https://github.com/apache/fluo-examples/tree/master/stresso
-[Phrasecount]: https://github.com/apache/fluo-examples/tree/master/phrasecount
-[website README]: https://github.com/apache/fluo-website/blob/master/README.md
+[Webindex]: https://github.com/apache/fluo-examples/tree/main/webindex
+[Stresso]: https://github.com/apache/fluo-examples/tree/main/stresso
+[Phrasecount]: https://github.com/apache/fluo-examples/tree/main/phrasecount
+[website README]: https://github.com/apache/fluo-website/blob/main/README.md
[example-email]: https://lists.apache.org/thread.html/8b6ec5f17e277ed2d01e8df61eb1f1f42266cd30b9e114cb431c1c17@%3Cdev.fluo.apache.org%3E
[KEYS]: https://www.apache.org/dist/fluo/KEYS
[sigs]: https://www.apache.org/dev/release-distribution.html#sigs-and-sums