-
Notifications
You must be signed in to change notification settings - Fork 108
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update README and tidy up docs #619
base: develop
Are you sure you want to change the base?
Conversation
Abhinandan-Purkait
commented
Jan 28, 2025
•
edited
Loading
edited
- Streamline README to have relevant content.
- Tidy up existing docs.
- Move deprecated assets to deprecated folder.
- Update changelog.
- Update RELEASE process.
- Remove changelog folder as that becomes a hassle to maintain.
5214ffc
to
ce57085
Compare
3. If a release is an RC tag then PR should include the changes to remove the changelog from `changelog/v0.7.x` which are already mentioned in `zfs-localpv/CHANGELOG.md` as part of step number 1. | ||
Once a release is created:- | ||
1. The repo owner updates the release page changelog with all the necessary content. | ||
2. The repo owner updates the [CHANGELOG.md](./CHANGELOG.md) file with the changelog for the release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally the CHANGELOG.md should be updated before the release and not after. One should be able to pull in the git repo and read the change summary on the CHANGELOG.md.
Updates after release requires online version control software like github to be present for viewing the changelog.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not entriely true, changelog is updated once the release it created. How does one add changelog before release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The release notes on the github release listing can't be created, that's true. However, the CHANGELOG.md can be updated before the release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please give me the wording for the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @niladrih
docs/quickstart.md
Outdated
@@ -0,0 +1,347 @@ | |||
## Usage and Deployment | |||
|
|||
### Prerequisites |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Should contain minimum supported kubernetes version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its there on the Readme
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want me to put it here as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @niladrih
Signed-off-by: Abhinandan Purkait <[email protected]>
ce57085
to
1dcc0d9
Compare
Signed-off-by: Abhinandan Purkait <[email protected]>
1dcc0d9
to
79b2923
Compare
RELEASE.md
Outdated
|
||
If any issues are found during the above stages, they are fixed and a new release candidate builds are generated. | ||
If any issues are found during the above stages, they are fixed and the prerelease tag is overidden by the newer changes and are up for above action items again. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"and are up for above action items again" means?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does this mean the tag is overridden?
btw s/overidden/overridden
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What I mean is, the tag is a fixed one and newer changes also are included in the same tag, for example 2.7.1-prerelease will have all the incremental changes going into release/2.7 branch till 2.7.1 is released.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and are up for above action items again" means?
Means everytime a new change goes in release/x.y from the point in time from creation of the branch release/x.y, the same prerelease tag is to be used for all testing and those list of items prior to release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this tag we're talking about here?
@@ -4,7 +4,7 @@ LocalPV-ZFS is a CSI driver for dynamically provisioning a volume in ZFS storage | |||
|
|||
### 2. How to install LocalPV-ZFS | |||
|
|||
Make sure that all the nodes have zfsutils-linux installed. We should go to the each node of the cluster and install zfs utils | |||
Make sure that all the nodes have zfsutils-linux installed. We should go to the each node of the cluster and install zfs utils. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to specify any version of zfsutils-linux here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also need to ensure they're available on a specific path location right? Otherwise need to override it on the chart?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to specify any version of zfsutils-linux here?
That is specified in the README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also need to ensure they're available on a specific path location right? Otherwise need to override it on the chart?
No we check at all the possible places and use wherever we find them. So mostly should be fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we check at all the possible places
No we don't, this doesn't work on NixOS
by default. And probably won't on other similar distros.
You have to either use custom location or create bind mounts for this to work.
docs/quickstart.md
Outdated
All nodes should have the same verion of zfsutils-linux installed. <BR> | ||
|
||
```bash | ||
$ apt-get install zfsutils-linux |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should make it clear this is for ubuntu?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only for ubuntu as in? It will work for any linux distro right? Even though package name might be different?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should clarify this example is just for ubuntu as command won't work for fedora or arch-linux for example
Signed-off-by: Abhinandan Purkait <[email protected]>
ea1c848
to
959f9d2
Compare