Skip to content

Commit

Permalink
Recitfy docs links, synchronize READMEs (quiltdata#921)
Browse files Browse the repository at this point in the history
  • Loading branch information
akarve authored Jul 2, 2019
1 parent 5f8a0f7 commit f143f7d
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
* /README.md and docs/README.md should be identical copies (symlinks don't work)
* Use only *absolute links* in these files. Relative links will break.
!-->
[![docs on_gitbook](https://img.shields.io/badge/docs-on_gitbook-blue.svg?style=flat-square)](https://quiltdocs.gitbook.io/quilt/)
[![docs on_gitbook](https://img.shields.io/badge/docs-on_gitbook-blue.svg?style=flat-square)](https://docs.quiltdata.com/)
[![chat on_slack](https://img.shields.io/badge/chat-on_slack-blue.svg?style=flat-square)](https://slack.quiltdata.com/)
[![codecov](https://codecov.io/gh/quiltdata/quilt/branch/master/graph/badge.svg)](https://codecov.io/gh/quiltdata/quilt)
[![pypi](https://img.shields.io/pypi/v/quilt.svg?style=flat-square)](https://pypi.org/project/quilt/)
[![pypi](https://img.shields.io/pypi/v/quilt.svg?style=flat-square)](https://pypi.org/project/quilt3/)

*Note: this is the documentation for [Quilt 3](https://blog.quiltdata.com/rethinking-s3-announcing-t4-a-team-data-hub-8e63ce7ec988). For Quilt 2 see [here](https://docs.quiltdata.com/v/quilt-2-master/) and [here](https://github.com/quiltdata/quilt/tree/quilt-2-master).*

Expand Down
2 changes: 1 addition & 1 deletion api/python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def readme():
management, and data version control using `data packages <https://blog.quiltdata.com/data-packages-for-fast-reproducible-python-analysis-c74b78015c7f>`_.
The `quilt` PyPi package allows you to build, push, and pull data packages in Quilt using Python.
Visit the `documentation quickstart <https://quiltdocs.gitbook.io/quilt/quickstart>`_ for more information.
Visit the `documentation quickstart <https://docs.quiltdata.com/quickstart>`_ for more information.
"""
return readme_short
Expand Down
1 change: 0 additions & 1 deletion catalog/app/constants/urls.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,4 @@ export const pipGit = `git+${git}`
export const icon256 = 'https://d1zvn9rasera71.cloudfront.net/q-256-square.png'
export const tutorial =
'https://github.com/quiltdata/quilt/blob/master/README.md#tutorial'
export const t4Docs = 'https://quiltdocs.gitbook.io/t4/'
export const twitter = 'https://twitter.com/quiltdata'
3 changes: 2 additions & 1 deletion catalog/app/containers/Bucket/Dir.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import * as NamedRoutes from 'utils/NamedRoutes'
import Link from 'utils/StyledLink'
import { getBreadCrumbs, ensureNoSlash, withoutPrefix, up } from 'utils/s3paths'

import { docs } from 'constants/urls'
import BreadCrumbs, { Crumb } from './BreadCrumbs'
import Code from './Code'
import Listing, { ListingItem } from './Listing'
Expand All @@ -22,7 +23,7 @@ import Summary from './Summary'
import { displayError } from './errors'
import * as requests from './requests'

const HELP_LINK = 'https://quiltdocs.gitbook.io/t4/walkthrough/working-with-a-bucket'
const HELP_LINK = `${docs}/walkthrough/working-with-a-bucket`

const getCrumbs = R.compose(
R.intersperse(Crumb.Sep(' / ')),
Expand Down
6 changes: 2 additions & 4 deletions catalog/app/containers/Bucket/PackageList.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import * as NamedRoutes from 'utils/NamedRoutes'
import Link from 'utils/StyledLink'
import { readableQuantity } from 'utils/string'

import { docs } from 'constants/urls'
import Message from './Message'
import { displayError } from './errors'
import * as requests from './requests'
Expand Down Expand Up @@ -89,10 +90,7 @@ export default ({
R.isEmpty,
() => (
<Message headline="No packages">
<Link href="https://quiltdocs.gitbook.io/t4/walkthrough/creating-a-package">
Learn how to create a package
</Link>
.
<Link href={`${docs}/walkthrough/`}>Learn how to create a package</Link> .
</Message>
),
R.pipe(
Expand Down
9 changes: 7 additions & 2 deletions catalog/app/containers/Bucket/errors.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { createStructuredSelector } from 'reselect'
import Button from '@material-ui/core/Button'

import * as Auth from 'containers/Auth'
import { docs } from 'constants/urls'
import * as NamedRoutes from 'utils/NamedRoutes'
import StyledLink from 'utils/StyledLink'
import { BaseError } from 'utils/error'
Expand Down Expand Up @@ -53,7 +54,9 @@ const defaultHandlers = [
<Message headline="Error">
Seems like this bucket is not configured for T4.
<br />
<StyledLink href="https://quiltdocs.gitbook.io/t4/references/technical-reference#deploy-a-private-quilt-instance-on-aws">
<StyledLink
href={`${docs}/references/technical-reference#deploy-a-private-quilt-instance-on-aws`}
>
Learn how to configure the bucket for T4
</StyledLink>
.
Expand All @@ -67,7 +70,9 @@ const defaultHandlers = [
<Message headline="Access Denied">
Seems like you don&apos;t have access to this bucket.
<br />
<StyledLink href="https://quiltdocs.gitbook.io/t4/walkthrough/working-with-the-catalog#access-control">
<StyledLink
href={`${docs}/walkthrough/working-with-the-catalog#access-control`}
>
Learn about access control in T4
</StyledLink>
.
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* /README.md and docs/README.md should be identical copies (symlinks don't work)
* Use only *absolute links* in these files. Relative links will break.
!-->
[![docs on_gitbook](https://img.shields.io/badge/docs-on_gitbook-blue.svg?style=flat-square)](https://quiltdocs.gitbook.io/quilt/)
[![docs on_gitbook](https://img.shields.io/badge/docs-on_gitbook-blue.svg?style=flat-square)](https://docs.quiltdata.com/)
[![chat on_slack](https://img.shields.io/badge/chat-on_slack-blue.svg?style=flat-square)](https://slack.quiltdata.com/)
[![codecov](https://codecov.io/gh/quiltdata/quilt/branch/master/graph/badge.svg)](https://codecov.io/gh/quiltdata/quilt)
[![pypi](https://img.shields.io/pypi/v/quilt.svg?style=flat-square)](https://pypi.org/project/quilt3/)
Expand All @@ -19,7 +19,7 @@ easy to version, test, share and catalog. Working with datasets in
Quilt speeds up model creation, accelerates experimentation, reduces
downtime, and increases the productivity of data science teams.

## A team data hub for S3
## Collaborate in S3

* Quilt adds search, content preview, versioning, and a Python API to any S3 bucket
* Every file in Quilt is versioned and searchable
Expand Down

0 comments on commit f143f7d

Please sign in to comment.