Skip to content

Commit

Permalink
Fix broken commands and URLs in the docs (#89)
Browse files Browse the repository at this point in the history
* Fix some broken commands and URLs in the docs

* Fix broken URLs in how-to-release doc
  • Loading branch information
hussein-awala authored and Fokko committed Oct 24, 2023
1 parent 7e263ae commit 1b186d6
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions mkdocs/docs/how-to-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Both the source distribution (`sdist`) and the binary distributions (`wheels`) n

Before committing the files to the Apache SVN artifact distribution SVN hashes need to be generated, and those need to be signed with gpg to make sure that they are authentic.

Go to [Github Actions and run the `Python release` action](https://github.com/apache/iceberg/actions/workflows/python-release.yml). **Set the version to main, since we cannot modify the source**. Download the zip, and sign the files:
Go to [Github Actions and run the `Python release` action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml). **Set the version to main, since we cannot modify the source**. Download the zip, and sign the files:

```bash
cd release-main/
Expand Down Expand Up @@ -106,8 +106,8 @@ A summary of the high level features:
The commit ID is $LAST_COMMIT_ID
* This corresponds to the tag: $GIT_TAG ($GIT_TAG_HASH)
* https://github.com/apache/iceberg/releases/tag/$GIT_TAG
* https://github.com/apache/iceberg/tree/$LAST_COMMIT_ID
* https://github.com/apache/iceberg-python/releases/tag/$GIT_TAG
* https://github.com/apache/iceberg-python/tree/$LAST_COMMIT_ID
The release tarball, signature, and checksums are here:
Expand Down Expand Up @@ -163,4 +163,4 @@ Thanks to everyone for contributing!

## Release the docs

A committer triggers the [`Python Docs` Github Actions](https://github.com/apache/iceberg/actions/workflows/python-ci-docs.yml) through the UI by selecting the branch that just has been released. This will publish the new docs.
A committer triggers the [`Python Docs` Github Actions](https://github.com/apache/iceberg-python/actions/workflows/python-ci-docs.yml) through the UI by selecting the branch that just has been released. This will publish the new docs.
8 changes: 4 additions & 4 deletions mkdocs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ You can install the latest release version from pypi:
pip install "pyiceberg[s3fs,hive]"
```

Install it directly for Github (not recommended), but sometimes handy:
Install it directly for GitHub (not recommended), but sometimes handy:

```
pip install "git+https://github.com/apache/iceberg.git#subdirectory=python&egg=pyiceberg[s3fs]"
pip install "git+https://github.com/apache/iceberg-python.git#egg=pyiceberg[s3fs]"
```

Or clone the repository for local development:

```sh
git clone https://github.com/apache/iceberg.git
cd iceberg/python
git clone https://github.com/apache/iceberg-python.git
cd iceberg-python
pip3 install -e ".[s3fs,hive]"
```

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ name = "pyiceberg"
version = "0.5.1"
readme = "README.md"
homepage = "https://py.iceberg.apache.org/"
repository = "https://github.com/apache/iceberg/"
repository = "https://github.com/apache/iceberg-python"
description = "Apache Iceberg is an open table format for huge analytic datasets"
authors = ["Apache Software Foundation <[email protected]>"]
license = "Apache License 2.0"
Expand Down

0 comments on commit 1b186d6

Please sign in to comment.