-
Notifications
You must be signed in to change notification settings - Fork 332
Fixing links (new PR for approved PR #136) #307
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
Conversation
|
I think @eric-maynard's comment in #136 is still valid, #136 (comment) |
| <p>If you’re using a storage type other than S3, such as Azure, you’ll provide a different type of credential than a Role ARN. For more details on supported storage types, see the <a href="./entities.md#storage-type">docs</a>.</p> | ||
| <p>Additionally, if Polaris is running somewhere other than <code>localhost:8181</code>, you can specify the correct hostname and port by providing <code>--host</code> and <code>--port</code> flags. For the full set of options supported by the CLI, please refer to the <a href="./command-line-interface.md">docs</a>.</p> | ||
| <p>If you’re using a storage type other than S3, such as Azure, you’ll provide a different type of credential than a Role ARN. For more details on supported storage types, see the <a href="#storage-type">docs</a>.</p> | ||
| <p>Additionally, if Polaris is running somewhere other than <code>localhost:8181</code>, you can specify the correct hostname and port by providing <code>--host</code> and <code>--port</code> flags. For the full set of options supported by the CLI, please refer to the <a href="https://github.com/apache/polaris/blob/main/docs/command-line-interface.md">docs</a>.</p> |
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.
If I am reading this correctly, clicking a link in a doc on the website will lead you to a doc on github? That feels bad
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.
To add to it, it points to the main branch only, which breaks other branches.
https://github.com/apache/polaris/blob/main/docs/...
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.
I'd recommend to move forward with a way to support a relative paths. We can play with building tools to support it.
| If you’re using a storage type other than S3, such as Azure, you’ll provide a different type of credential than a Role ARN. For more details on supported storage types, see the [docs](#storage-type). | ||
|
|
||
| Additionally, if Polaris is running somewhere other than `localhost:8181`, you can specify the correct hostname and port by providing `--host` and `--port` flags. For the full set of options supported by the CLI, please refer to the [docs](./command-line-interface.md). | ||
| Additionally, if Polaris is running somewhere other than `localhost:8181`, you can specify the correct hostname and port by providing `--host` and `--port` flags. For the full set of options supported by the CLI, please refer to the [docs](https://github.com/apache/polaris/blob/main/docs/command-line-interface.md). |
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.
command-line-interface.md is in the same directory as this file. We don't need this change.
|
Hi @jaret-basden , the new website is online now, can you double check how this PR applies to new docs framework? I assume some changes are not needed anymore, you can check details here, https://polaris.apache.org/in-dev/unreleased/quickstart/ |
Description
Opening this PR to redo most of the changes in approved PR #136. PR #136 has gotten out of sync, so I'm opening this new PR instead of rebasing.
I didn't fix the docs link in docs/command-line-interface.md per jbonofre's comment in closed PR #231.
Fixes # (issue): N/A
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Checklist:
Please delete options that are not relevant.