Skip to content

Conversation

@j143
Copy link
Member

@j143 j143 commented Jun 30, 2021

Add release documentation

Step 0: Prerequisites

git clone https://github.com/apache/systemds
git clone https://github.com/apache/systemds-website

Step 1:

generate docs with as per https://github.com/apache/systemds/tree/master/docs

# In this case the release tag is 2.1.0-rc3
git checkout 2.1.0-rc3

cd systemds/docs

./updateAPI.sh

Step 2:

copy the contents to systemds-website repo

cd systemds-website

# create a new directory with release no.
mkdir content/docs/2.1.0

# copy the files in docs/_site folder to 2.1.0
cp -r ../systemds/docs/_site/* content/docs/2.1.0

Then follow, https://github.com/apache/systemds-website#updating-the-website

Website Preview at https://systemds.staged.apache.org


Closes j143/systemds#175

@j143 j143 force-pushed the release-2.1.0-docs branch from fbfef89 to 6da1c43 Compare June 30, 2021 12:54
@j143 j143 merged commit e1615ae into apache:asf-staging Jun 30, 2021
@j143 j143 deleted the release-2.1.0-docs branch October 30, 2021 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant