Fix README release instructions and lint errors

Signed-off-by: Anish Asthana <[email protected]>

Author: anishasthana

README.md

@@ -6,9 +6,10 @@
 An intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.
 
 For guided demos and basics walkthroughs, check out the following links:
- - Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/notebook-ex-outputs) also available
- - Note that these notebooks will work with the latest `codeflare-sdk` PyPI release. For testing and experimentation with `main` branch, please use the [preview notebooks](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/preview_nbs)
- - Additionally, we have a [video walkthrough](https://www.youtube.com/watch?v=U76iIfd9EmE) of these basic demos from June, 2023
+
+- Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/notebook-ex-outputs) also available
+- Note that these notebooks will work with the latest `codeflare-sdk` PyPI release. For testing and experimentation with `main` branch, please use the [preview notebooks](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/preview_nbs)
+- Additionally, we have a [video walkthrough](https://www.youtube.com/watch?v=U76iIfd9EmE) of these basic demos from June, 2023
 
 Full documentation can be found [here](https://project-codeflare.github.io/codeflare-sdk/)
 
@@ -54,7 +55,6 @@ To build the python package: `$ poetry build`
 
 ## Release Instructions
 
-
 ### Automated Releases
 
 It is possible to use the Release Github workflow to do the release. This is generally the process we follow for releases
@@ -63,19 +63,18 @@ It is possible to use the Release Github workflow to do the release. This is gen
 
 The following instructions apply when doing release manually. This may be required in instances where the automation is failing.
 
-* Check and update the version in "pyproject.toml" file.
-* Generate new documentation.
+- Check and update the version in "pyproject.toml" file.
+- Generate new documentation.
 `pdoc --html -o docs src/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs -type f -name "*.html" -exec bash -c "echo '' >> {}" \;` (it is possible to install **pdoc** using the following command `poetry install --with docs`)
-* Commit all the changes to the repository.
-* Create Github release (https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).
-* Build the Python package. `poetry build`
-* If not present already, add the API token to Poetry.
+- Commit all the changes to the repository.
+- Create Github release (<https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release>).
+- Build the Python package. `poetry build`
+- If not present already, add the API token to Poetry.
 `poetry config pypi-token.pypi API_TOKEN`
-* Publish the Python package. `poetry publish`
-* Change directory to custom-nb-image. `cd custom-nb-image`
-* Set tag `export tag=TAG`
-* Build the Docker image. `docker build --build-arg SDK_VERSION=<version> -t quay.io/project-codeflare/notebook:${tag} .`
-* Tag the image as latest. `docker tag quay.io/project-codeflare/notebook:${tag} quay.io/project-codeflare/notebook:latest`
-* Login to quay.io. `docker login quay.io`
-* Push the image. `docker push quay.io/project-codeflare/notebook:${tag}`
-* Push the image. `docker push quay.io/project-codeflare/notebook:latest`
+- Publish the Python package. `poetry publish`
+- Change directory to custom-nb-image. `cd custom-nb-image`
+- Set tag `export tag=TAG`
+- Build the container image. `podman build --build-arg SDK_VERSION=<version> -t quay.io/project-codeflare/notebook:${tag} .`
+- Login to quay.io. `podman login quay.io`
+- Push the image. `podman push quay.io/project-codeflare/notebook:${tag}`
+- Push the stable image tag `podman push quay.io/project-codeflare/notebook:${tag} quay.io/project-codeflare/notebook:stable`