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

New Docs Site #2620

Merged
merged 31 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
3bcd84b
Initial commit for new docs site. Still needs blogs, content transiti…
Sep 22, 2023
77dde7b
add edited versions of existing blog posts and remove examples
merobi-hub Sep 22, 2023
b5f59c3
configure blog
merobi-hub Sep 22, 2023
ca949b7
edit blog config
merobi-hub Sep 22, 2023
c7b81da
improve truncated versions of posts
merobi-hub Sep 22, 2023
2611816
add edited quickstart and remove templates
merobi-hub Sep 22, 2023
455cfcd
put back intro to fix broken links
merobi-hub Sep 22, 2023
15788a7
add about page
merobi-hub Sep 22, 2023
64d27a2
Minor social updates and removal of tutorial.
Sep 25, 2023
670a67c
Merge branch 'docs/v2' of github.com:MarquezProject/marquez into docs/v2
merobi-hub Sep 26, 2023
2a0033c
add resources page and move deployment guide to docs
merobi-hub Sep 26, 2023
a60500f
add faq to docs
merobi-hub Sep 26, 2023
bc7cd3b
remove example tutorial from docs
merobi-hub Sep 26, 2023
bc84647
fix link in deployment guide and center footer links
merobi-hub Sep 26, 2023
e66f747
continued
merobi-hub Sep 26, 2023
dfd3453
Fixes broken link.
merobi-hub Oct 2, 2023
a2466d9
Configures docusaurus for test deployment on netlify.
merobi-hub Oct 2, 2023
5f574e2
Fixes preview image.
merobi-hub Oct 2, 2023
56ecdc5
Changes site social card.
merobi-hub Oct 3, 2023
5e3f797
Changes site social card - continued.
merobi-hub Oct 3, 2023
1bb9cb6
Changes site social card - continued.
merobi-hub Oct 3, 2023
b71a043
Changes site social card - continued.
merobi-hub Oct 3, 2023
c43345d
Changes site social card - continued.
merobi-hub Oct 3, 2023
7ea3ff1
Changes title in meta tag.
merobi-hub Oct 3, 2023
f295226
Resizes site social card.
merobi-hub Oct 3, 2023
6f6ce58
Fixes site social card.
merobi-hub Oct 3, 2023
1d6b76f
Adds tagline to site social card.
merobi-hub Oct 3, 2023
f954d2a
Merge branch 'main' into docs/v2
merobi-hub Oct 3, 2023
5a548ce
Adds CNAME.
merobi-hub Oct 3, 2023
a4874b1
Merge branch 'docs/v2' of github.com:MarquezProject/marquez into docs/v2
merobi-hub Oct 3, 2023
05d7e6c
Moves new site to new dir v2 in docs.
merobi-hub Oct 3, 2023
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
20 changes: 20 additions & 0 deletions docs/v2/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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*
1 change: 1 addition & 0 deletions docs/v2/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
marquezproject.ai
50 changes: 50 additions & 0 deletions docs/v2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Generating Docs

```bash
# clean
yarn docusaurus clean-api-docs all
# generate
yarn docusaurus gen-api-docs all
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> 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.
3 changes: 3 additions & 0 deletions docs/v2/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
Loading
Loading