Skip to content

Conversation

@jaret-basden
Copy link

@jaret-basden jaret-basden commented Sep 17, 2024

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.

  • docs/entities.md: Updated some links so they use an absolute link. Currently, they use a relative link, which doesn't work with the Redocly output (broken link).
  • docs/overview.md: Updated some links so they they point to an id attribute to align with the Redocly output. Currently, they point to a raw .md file in the /docs folder. The Redocly output combines .md files in the /docs folder into a single index.html file.
  • docs/quickstart.md:

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.

  • Documentation update

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 A
  • Test B

Test Configuration:

  • Hardware:
  • Toolchain:
  • SDK:

Checklist:

Please delete options that are not relevant.

  • I have tested the links locally in my browser (Chrome)

@flyrain
Copy link
Contributor

flyrain commented Sep 19, 2024

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>
Copy link
Contributor

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

Copy link
Contributor

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/...

Copy link
Contributor

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.

@RussellSpitzer RussellSpitzer mentioned this pull request Sep 25, 2024
5 tasks
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).
Copy link
Contributor

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.

@flyrain
Copy link
Contributor

flyrain commented Oct 2, 2024

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/

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.

4 participants