Skip to content

Commit f01c172

Browse files
authored
Merge pull request apache#1082 from apache/docsREADME
update master docs to the next release version
2 parents a44d8db + 328bf63 commit f01c172

File tree

6 files changed

+13
-11
lines changed

6 files changed

+13
-11
lines changed

RELEASE.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ And before you proceed, do the following steps:
2626
* Checkout the $VERSION branch.
2727
* Update the gradle.properties s.t. the following property is $VERSION w/o the suffix '-SNAPSHOT':
2828
version=$VERSION
29-
* Change the samza_executable variable in samza-test/src/main/python/configs/tests.json to $VERSION w/o the suffix '-SNAPSHOT'.
29+
* Change the samza_executable variable in samza-test/src/main/python/configs/tests.json to $VERSION w/o the suffix '-SNAPSHOT'.
3030
* Change the samza-test versions in samza-test/src/main/config/join/README to $VERSION w/o the suffix '-SNAPSHOT'.
3131
* Change the executable version in samza-test/src/main/python/stream_processor.py to $VERSION w/o the suffix '-SNAPSHOT'.
3232
* Push the changes to the $VERSION branch
@@ -149,6 +149,7 @@ The instructions above publish the Samza artifacts for scala 2.11. To publish fo
149149

150150
If the VOTE has successfully passed on the release candidate, you can log in to the [repository web interface](https://repository.apache.org) (same as above) and "release" the org.apache.samza repository listed under "Staging Repositories". This may take a minute or so.
151151
This will publish the samza release artifacts to the open source [maven repository](https://repo1.maven.org/maven2).
152+
Update gradle.properties with the next master version (1.0.0 -> 1.1.0 for example).
152153

153154
## Steps to Upload Source Tarball to Apache SVN
154155

@@ -158,7 +159,7 @@ Check out the following Apache dist SVN to local:
158159
svn checkout https://dist.apache.org/repos/dist/release/samza samza-dist
159160
```
160161

161-
Create the new version's sub-directory and add the source tarball, MD5, and asc files from the
162+
Create the new version's sub-directory and add the source tarball, MD5, and asc files from the
162163
previous step to the new directory:
163164

164165
```bash
@@ -177,11 +178,11 @@ Commit to Apache release SVN
177178
```
178179

179180
Check the download link [here](http://www-us.apache.org/dist/samza/) to make sure that the mirror
180-
site has picked up the new release. The third-party mirrors may take upto 24 hours to pick-up the release.
181-
In order to ensure that the release is available in public mirrors, wait for the release jars
181+
site has picked up the new release. The third-party mirrors may take upto 24 hours to pick-up the release.
182+
In order to ensure that the release is available in public mirrors, wait for the release jars
182183
to show up in [maven central](http://search.maven.org/#search%7Cga%7C1%7Csamza). A full list of mirrors can be found [here](http://www.apache.org/dyn/closer.cgi).
183184
Do not publish the website or any public document until the release jars are available for download.
184185

185186
## Steps to Update Public Documentation
186187

187-
Please refer to docs/README.md, specifically "Release-new-version Website Checklist" section.
188+
Please refer to docs/README.md, specifically "Release-new-version Website Checklist" section.

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ Following can be done when updating the gradle.properties file
8787
* if this is a major release, add the x.x.x release part in docs/archive/index.html
8888

8989
* update the download page (docs/startup/download/index.md) to use x.x.x release
90-
* Add an entry to the Sources releases and Samza Tools section to use the new x.x.x release
91-
(samza/docs/_releases/x.x.x.md)
90+
by adding an entry to the Sources and Samza Tools sections to use the new x.x.x release
91+
92+
* add a release page samza/docs/_releases/x.x.x.md
9293

9394
* update the version number in "tar -xvf ./target/hello-samza-y.y.y-dist.tar.gz -C deploy/samza" in each of the tutorials (and search for other uses of version x.x.x which may need to be replaced with y.y.y)
9495
* docs/startup/hello-samza/versioned/index.md

docs/learn/tutorials/versioned/hello-samza-high-level-zk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ With the environment setup complete, let us move on to building the hello-samza
5959
{% highlight bash %}
6060
mvn clean package
6161
mkdir -p deploy/samza
62-
tar -xvf ./target/hello-samza-1.2.0-SNAPSHOT-dist.tar.gz -C deploy/samza
62+
tar -xvf ./target/hello-samza-1.3.0-SNAPSHOT-dist.tar.gz -C deploy/samza
6363
{% endhighlight %}
6464

6565
We are now all set to deploy the application locally.

docs/learn/tutorials/versioned/samza-rest-getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Run the following commands:
4848
{% highlight bash %}
4949
cd samza-rest/build/distributions/
5050
mkdir -p deploy/samza-rest
51-
tar -xvf ./samza-rest-1.2.0-SNAPSHOT.tgz -C deploy/samza-rest
51+
tar -xvf ./samza-rest-1.3.0-SNAPSHOT.tgz -C deploy/samza-rest
5252
{% endhighlight %}
5353

5454
#### Configure the Installations Path

docs/startup/hello-samza/versioned/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Then, you can continue w/ the following command in hello-samza project:
6161
{% highlight bash %}
6262
mvn clean package
6363
mkdir -p deploy/samza
64-
tar -xvf ./target/hello-samza-1.2.0-SNAPSHOT-dist.tar.gz -C deploy/samza
64+
tar -xvf ./target/hello-samza-1.3.0-SNAPSHOT-dist.tar.gz -C deploy/samza
6565
{% endhighlight %}
6666

6767
### Run a Samza Job

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
group=org.apache.samza
18-
version=1.1.1-SNAPSHOT
18+
version=1.3.0-SNAPSHOT
1919
scalaSuffix=2.11
2020

2121
gradleVersion=4.8

0 commit comments

Comments
 (0)