-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: hosted documentation website (#2174)
- Loading branch information
Showing
67 changed files
with
13,503 additions
and
110 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: documentation | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - master | ||
| push: | ||
| branches: | ||
| - master | ||
| # release: | ||
| # types: [published, edited] | ||
|
|
||
| jobs: | ||
| gh-pages: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v1 | ||
| - uses: actions/setup-node@v1 | ||
| with: | ||
| node-version: '14.x' | ||
| - name: Build | ||
| run: | | ||
| cd docs-website | ||
| yarn install --frozen-lockfile | ||
| yarn run lint-check | ||
| yarn run generate | ||
| yarn run build | ||
| - name: Deploy | ||
| if: github.event_name == 'push' | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./docs-website/build | ||
| cname: datahubproject.io |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,8 @@ | ||
| --- | ||
| title: "Deploying with Docker" | ||
| hide_title: true | ||
| --- | ||
|
|
||
| # Docker Images | ||
|
|
||
| ## Prerequisites | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /genDocs | ||
|
|
||
| # Dependencies | ||
| /node_modules | ||
|
|
||
| # Production | ||
| /build | ||
|
|
||
| # Generated files | ||
| .docusaurus | ||
| .cache-loader | ||
|
|
||
| # Misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Website | ||
|
|
||
| This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```console | ||
| yarn install | ||
| ``` | ||
|
|
||
| ## Local Development | ||
|
|
||
| ```console | ||
| yarn start | ||
| ``` | ||
|
|
||
| This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| ## Build | ||
|
|
||
| ```console | ||
| yarn build | ||
| ``` | ||
|
|
||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
|
||
| ## Deployment | ||
|
|
||
| ```console | ||
| GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy | ||
| ``` | ||
|
|
||
| If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| module.exports = { | ||
| presets: [require.resolve("@docusaurus/core/lib/babel/preset")], | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| module.exports = { | ||
| title: "DataHub", | ||
| tagline: "A Generalized Metadata Search & Discovery Tool", | ||
| url: "https://datahubproject.io", | ||
| baseUrl: "/", | ||
| onBrokenLinks: "throw", | ||
| onBrokenMarkdownLinks: "throw", | ||
| favicon: "img/favicon.ico", | ||
| organizationName: "linkedin", // Usually your GitHub org/user name. | ||
| projectName: "datahub", // Usually your repo name. | ||
| themeConfig: { | ||
| navbar: { | ||
| title: "DataHub", | ||
| logo: { | ||
| alt: "DataHub Logo", | ||
| src: "img/logo-color.png", | ||
| srcDark: "img/logo-dark.png", | ||
| }, | ||
| items: [ | ||
| { | ||
| to: "docs/", | ||
| activeBasePath: "docs", | ||
| label: "Docs", | ||
| position: "right", | ||
| }, | ||
| { | ||
| to: | ||
| "https://join.slack.com/t/datahubspace/shared_invite/zt-dkzbxfck-dzNl96vBzB06pJpbRwP6RA", | ||
| label: "Slack", | ||
| position: "right", | ||
| }, | ||
| { | ||
| to: "docs/demo", | ||
| label: "Demo", | ||
| position: "right", | ||
| }, | ||
| { | ||
| href: "https://github.com/linkedin/datahub", | ||
| label: "GitHub", | ||
| position: "right", | ||
| }, | ||
| ], | ||
| }, | ||
| footer: { | ||
| style: "dark", | ||
| links: [ | ||
| { | ||
| title: "Docs", | ||
| items: [ | ||
| { | ||
| label: "Introduction", | ||
| to: "docs/", | ||
| }, | ||
| { | ||
| label: "Quickstart", | ||
| to: "docs/quickstart", | ||
| }, | ||
| { | ||
| label: "Features", | ||
| to: "docs/features", | ||
| }, | ||
| { | ||
| label: "FAQs", | ||
| to: "docs/faq", | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: "Community", | ||
| items: [ | ||
| { | ||
| label: "Slack", | ||
| href: | ||
| "https://join.slack.com/t/datahubspace/shared_invite/zt-dkzbxfck-dzNl96vBzB06pJpbRwP6RA", | ||
| }, | ||
| { | ||
| label: "YouTube", | ||
| href: "https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w", | ||
| }, | ||
| { | ||
| label: "Town Halls", | ||
| to: "docs/townhalls", | ||
| }, | ||
| { | ||
| label: "Adoption", | ||
| to: "docs/#adoption", | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: "More", | ||
| items: [ | ||
| { | ||
| label: "Demo", | ||
| href: "docs/demo", | ||
| }, | ||
| { | ||
| label: "Roadmap", | ||
| to: "docs/roadmap", | ||
| }, | ||
| { | ||
| label: "Contributing", | ||
| to: "docs/contributing", | ||
| }, | ||
| { | ||
| label: "GitHub", | ||
| href: "https://github.com/linkedin/datahub", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| copyright: `Copyright © 2015-${new Date().getFullYear()} DataHub Project Authors.`, | ||
| }, | ||
| // prism: { | ||
| // theme: require('prism-react-renderer/themes/github'), | ||
| // darkTheme: require('prism-react-renderer/themes/dracula'), | ||
| // }, | ||
| gtag: { | ||
| trackingID: "G-2G54RXWD4D", | ||
| }, | ||
| algolia: { | ||
| apiKey: "26a4b687e96e7476b5a6f11365a83336", | ||
| indexName: "datahubproject", | ||
| // contextualSearch: true, | ||
| // searchParameters: {}, | ||
| // debug: true, | ||
| }, | ||
| }, | ||
| presets: [ | ||
| [ | ||
| "@docusaurus/preset-classic", | ||
| { | ||
| docs: { | ||
| path: "genDocs", | ||
| sidebarPath: require.resolve("./sidebars.js"), | ||
| editUrl: "https://github.com/linkedin/datahub/blob/master/", | ||
| // TODO: make these work correctly with the doc generation | ||
| showLastUpdateAuthor: true, | ||
| showLastUpdateTime: true, | ||
| }, | ||
| blog: false, | ||
| theme: { | ||
| customCss: require.resolve("./src/css/custom.css"), | ||
| }, | ||
| }, | ||
| ], | ||
| ], | ||
| plugins: [ | ||
| "@docusaurus/plugin-ideal-image", | ||
| // '@docusaurus/plugin-google-gtag', | ||
| // [ | ||
| // require.resolve("@easyops-cn/docusaurus-search-local"), | ||
| // { | ||
| // // `hashed` is recommended as long-term-cache of index file is possible. | ||
| // hashed: true, | ||
| // language: ["en"], | ||
| // docsDir: "genDocs", | ||
| // blogDir: [], | ||
| // }, | ||
| // ], | ||
| ], | ||
| }; |
Oops, something went wrong.