Skip to content
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

Fix some doc URLs in catalog #4205

Merged
merged 15 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions catalog/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ where verb is one of

## Changes

- [Fixed] Fix some doc URLs in catalog ([#4205](https://github.com/quiltdata/quilt/pull/4205))
- [Changed] S3 Select -> GQL API calls for getting access counts ([#4218](https://github.com/quiltdata/quilt/pull/4218))
- [Changed] Athena: improve loading state and errors visuals; fix minor bugs; alphabetize and persist selection in workgroups, catalog names and databases ([#4208](https://github.com/quiltdata/quilt/pull/4208))
- [Changed] Show stack release version in footer ([#4200](https://github.com/quiltdata/quilt/pull/4200))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ function Header() {
return (
<M.Typography variant="body2">
Configuration for Catalog UI: show and hide features, set default values. See{' '}
<StyledLink href={`${docs}/catalog/preferences`} target="_blank">
<StyledLink
href={`${docs}/quilt-platform-administrator/preferences`}
target="_blank"
>
the docs
</StyledLink>
</M.Typography>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function Header() {
return (
<M.Typography variant="body2">
Configuration for data quality workflows. See{' '}
<StyledLink href={`${docs}/advanced/workflows`} target="_blank">
<StyledLink href={`${docs}/workflows`} target="_blank">
the docs
</StyledLink>
</M.Typography>
Expand Down
5 changes: 4 additions & 1 deletion catalog/app/containers/Admin/Status/Status.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ export default function Status() {
GxP and other compliance regimes.
</M.Typography>
<M.Typography align="center">
<StyledLink href={`${docs}/advanced/good-practice`} target="_blank">
<StyledLink
href={`${docs}/quilt-platform-administrator/best-practices/good-practice`}
target="_blank"
>
Learn more
</StyledLink>{' '}
or <StyledLink href="mailto:[email protected]">contact sales</StyledLink>.
Expand Down
5 changes: 4 additions & 1 deletion catalog/app/containers/Admin/UsersAndRoles/SsoConfig.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,10 @@ function Form({
<FormError error={error || submitError} errors={FORM_ERRORS} />
<M.Typography variant="body2">
Learn more about{' '}
<StyledLink href={`${docs}/advanced/sso-permissions`} target="_blank">
<StyledLink
href={`${docs}/quilt-platform-administrator/advanced/sso-permissions`}
target="_blank"
>
SSO permissions mapping
</StyledLink>
.
Expand Down
4 changes: 2 additions & 2 deletions catalog/app/containers/Bucket/CodeSamples/Dir.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ const TEMPLATES = {
dedent`
import quilt3 as q3
b = q3.Bucket("s3://${bucket}")
# List files [[${docs}/api-reference/bucket#bucket.ls]]
# List files [[${docs}/quilt-python-sdk-developers/api-reference/bucket#bucket.ls]]
b.ls("${path}")
# Download [[${docs}/api-reference/bucket#bucket.fetch]]
# Download [[${docs}/quilt-python-sdk-developers/api-reference/bucket#bucket.fetch]]
b.fetch("${path}", "./${dest}")
`,
CLI: (bucket: string, path: string, dest: string) =>
Expand Down
2 changes: 1 addition & 1 deletion catalog/app/containers/Bucket/CodeSamples/File.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const TEMPLATES = {
dedent`
import quilt3 as q3
b = q3.Bucket("s3://${bucket}")
# Download [[${docs}/api-reference/bucket#bucket.fetch]]
# Download [[${docs}/quilt-python-sdk-developers/api-reference/bucket#bucket.fetch]]
b.fetch("${path}", "./${basename(path)}")
`,
CLI: (bucket: string, path: string) =>
Expand Down
14 changes: 7 additions & 7 deletions catalog/app/containers/Bucket/CodeSamples/Package.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,30 @@ const TEMPLATES = {
const hashPy = hashDisplay && `, top_hash="${hashDisplay}"`
return dedent`
import quilt3 as q3
# Browse [[${docs}/api-reference/package#package.browse]]
# Browse [[${docs}/quilt-python-sdk-developers/api-reference/package#package.browse]]
p = q3.Package.browse("${name}"${hashPy}, registry="s3://${bucket}")
# make changes to package adding individual files [[${docs}/api-reference/package#package.set]]
# make changes to package adding individual files [[${docs}/quilt-python-sdk-developers/api-reference/package#package.set]]
p.set("data.csv", "data.csv")
# or whole directories [[${docs}/api-reference/package#package.set_dir]]
# or whole directories [[${docs}/quilt-python-sdk-developers/api-reference/package#package.set_dir]]
p.set_dir("subdir", "subdir")
# and push changes [[${docs}/api-reference/package#package.push]]
# and push changes [[${docs}/quilt-python-sdk-developers/api-reference/package#package.push]]
p.push("${name}", registry="s3://${bucket}", message="Hello World")

# Download (be mindful of large packages) [[${docs}/api-reference/package#package.push]]
# Download (be mindful of large packages) [[${docs}/quilt-python-sdk-developers/api-reference/package#package.install]]
q3.Package.install("${name}"${pathPy}${hashPy}, registry="s3://${bucket}", dest=".")
`
},
CLI_DOWNLOAD: (bucket: string, name: string, path: string, hashDisplay: string) => {
const pathCli = path && ` --path "${s3paths.ensureNoSlash(path)}"`
const hashCli = hashDisplay && ` --top-hash ${hashDisplay}`
return dedent`
# Download package [[${docs}/api-reference/cli#install]]
# Download package [[${docs}/quilt-python-sdk-developers/api-reference/cli#install]]
quilt3 install "${name}"${pathCli}${hashCli} --registry s3://${bucket} --dest .
`
},
CLI_UPLOAD: (bucket: string, name: string) =>
dedent`
# Upload package [[${docs}/api-reference/cli#push]]
# Upload package [[${docs}/quilt-python-sdk-developers/api-reference/cli#push]]
echo "Hello World" > README.md
quilt3 push "${name}" --registry s3://${bucket} --dir .
`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const errorDisplay = R.cond([
Please fix the{' '}
<WorkflowsConfigLink bucket={bucket}>workflows config</WorkflowsConfigLink>{' '}
according to{' '}
<StyledLink href={`${docs}/advanced/workflows`} target="_blank">
<StyledLink href={`${docs}/workflows`} target="_blank">
the documentation
</StyledLink>
.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export default function SelectWorkflow({
</M.Select>
<M.FormHelperText>
{!!error && <span className={classes.error}>{error}</span>}
<M.Link href={`${docs}/advanced/workflows`} target="_blank">
<M.Link href={`${docs}/workflows`} target="_blank">
Learn about data quality workflows
</M.Link>
, or edit{' '}
Expand Down
6 changes: 4 additions & 2 deletions catalog/app/containers/Bucket/Queries/Athena/Workgroups.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,10 @@ function WorkgroupsEmpty({ error }: WorkgroupsEmptyProps) {
<M.Box mt={1}>
<M.Typography variant="body2">
Check{' '}
<StyledLink href={`${docs}/advanced/athena`}>Athena Queries docs</StyledLink> on
setup and correct usage
<StyledLink href={`${docs}/quilt-platform-catalog-user/advanced/athena`}>
Athena Queries docs
</StyledLink>{' '}
on setup and correct usage
</M.Typography>
</M.Box>
</>
Expand Down
4 changes: 2 additions & 2 deletions catalog/app/containers/Bucket/Successors.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function EmptySlot({ bucket }: EmptySlotProps) {
</M.Typography>
<M.Typography>
<StyledLink
href={`${docs}/advanced/workflows#cross-bucket-package-push-quilt-catalog`}
href={`${docs}/workflows#cross-bucket-package-push-quilt-catalog`}
target="_blank"
>
Learn more
Expand All @@ -52,7 +52,7 @@ function ErrorSlot({ error }: ErrorSlotProps) {
{error instanceof ERRORS.WorkflowsConfigInvalid && (
<M.Typography>
Please fix the workflows config according to{' '}
<StyledLink href={`${docs}/advanced/workflows`} target="_blank">
<StyledLink href={`${docs}/workflows`} target="_blank">
the documentation
</StyledLink>
</M.Typography>
Expand Down
4 changes: 3 additions & 1 deletion catalog/app/containers/Bucket/Summarize.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,9 @@ function SummaryFailed({ error }: SummaryFailedProps) {
<M.Typography>Check your quilt_summarize.json file for errors.</M.Typography>
<M.Typography>
See the{' '}
<Link href={`${docs}/catalog/visualizationdashboards#quilt_summarize.json`}>
<Link
href={`${docs}/quilt-platform-catalog-user/visualizationdashboards#quilt_summarize.json`}
>
summarize docs
</Link>{' '}
for more.
Expand Down
4 changes: 2 additions & 2 deletions catalog/app/containers/Bucket/errors.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ const defaultHandlers: ErrorHandler[] = [
<br />
<StyledLink
target="_blank"
href={`${docs}/advanced/technical-reference#preparing-an-aws-role-for-use-with-quilt`}
href={`${docs}/quilt-platform-administrator/technical-reference#preparing-an-aws-role-for-use-with-quilt`}
>
Learn how to configure the bucket for Quilt
</StyledLink>
Expand Down Expand Up @@ -167,7 +167,7 @@ const defaultHandlers: ErrorHandler[] = [
<br />
<StyledLink
target="_blank"
href={`${docs}/walkthrough/working-with-the-catalog#access-control`}
href={`${docs}/quilt-platform-administrator/admin#users-and-roles`}
sir-sigurd marked this conversation as resolved.
Show resolved Hide resolved
>
Learn about access control in Quilt
</StyledLink>
Expand Down
5 changes: 4 additions & 1 deletion catalog/app/containers/NavBar/Suggestions/Suggestions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ function SuggestionsList({ items, selected }: SuggestionsProps) {
))}
<div className={classes.help}>
Learn the{' '}
<StyledLink href={`${docs}/catalog/searchquery#search-bar`} target="_blank">
<StyledLink
href={`${docs}/quilt-platform-catalog-user/searchquery#search-bar`}
target="_blank"
>
advanced search syntax
</StyledLink>{' '}
for query string queries in ElasticSearch {ES_V}.
Expand Down