Skip to content

Commit 75da43c

Browse files
phixMephixmerobi-hub
authored
New Docs Site (#2620)
* Initial commit for new docs site. Still needs blogs, content transitioned over. * add edited versions of existing blog posts and remove examples Signed-off-by: Michael Robinson <merobi@gmail.com> * configure blog Signed-off-by: Michael Robinson <merobi@gmail.com> * edit blog config Signed-off-by: Michael Robinson <merobi@gmail.com> * improve truncated versions of posts Signed-off-by: Michael Robinson <merobi@gmail.com> * add edited quickstart and remove templates Signed-off-by: Michael Robinson <merobi@gmail.com> * put back intro to fix broken links Signed-off-by: Michael Robinson <merobi@gmail.com> * add about page Signed-off-by: Michael Robinson <merobi@gmail.com> * Minor social updates and removal of tutorial. * add resources page and move deployment guide to docs Signed-off-by: Michael Robinson <merobi@gmail.com> * add faq to docs Signed-off-by: Michael Robinson <merobi@gmail.com> * remove example tutorial from docs Signed-off-by: Michael Robinson <merobi@gmail.com> * fix link in deployment guide and center footer links Signed-off-by: Michael Robinson <merobi@gmail.com> * continued Signed-off-by: Michael Robinson <merobi@gmail.com> * Fixes broken link. Signed-off-by: Michael Robinson <merobi@gmail.com> * Configures docusaurus for test deployment on netlify. Signed-off-by: Michael Robinson <merobi@gmail.com> * Fixes preview image. Signed-off-by: Michael Robinson <merobi@gmail.com> * Changes site social card. Signed-off-by: Michael Robinson <merobi@gmail.com> * Changes site social card - continued. Signed-off-by: Michael Robinson <merobi@gmail.com> * Changes site social card - continued. Signed-off-by: Michael Robinson <merobi@gmail.com> * Changes site social card - continued. Signed-off-by: Michael Robinson <merobi@gmail.com> * Changes site social card - continued. Signed-off-by: Michael Robinson <merobi@gmail.com> * Changes title in meta tag. Signed-off-by: Michael Robinson <merobi@gmail.com> * Resizes site social card. Signed-off-by: Michael Robinson <merobi@gmail.com> * Fixes site social card. Signed-off-by: Michael Robinson <merobi@gmail.com> * Adds tagline to site social card. Signed-off-by: Michael Robinson <merobi@gmail.com> * Adds CNAME. Signed-off-by: Michael Robinson <merobi@gmail.com> * Moves new site to new dir v2 in docs. Signed-off-by: Michael Robinson <merobi@gmail.com> --------- Signed-off-by: Michael Robinson <merobi@gmail.com> Co-authored-by: phix <peter.hicks@astronomer.io> Co-authored-by: Michael Robinson <merobi@gmail.com> Co-authored-by: Michael Robinson <68482867+merobi-hub@users.noreply.github.com>
1 parent 01ed782 commit 75da43c

88 files changed

Lines changed: 15263 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/v2/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

docs/v2/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
marquezproject.ai

docs/v2/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Generating Docs
12+
13+
```bash
14+
# clean
15+
yarn docusaurus clean-api-docs all
16+
# generate
17+
yarn docusaurus gen-api-docs all
18+
```
19+
20+
### Local Development
21+
22+
```
23+
$ yarn start
24+
```
25+
26+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
27+
28+
### Build
29+
30+
```
31+
$ yarn build
32+
```
33+
34+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
35+
36+
### Deployment
37+
38+
Using SSH:
39+
40+
```
41+
$ USE_SSH=true yarn deploy
42+
```
43+
44+
Not using SSH:
45+
46+
```
47+
$ GIT_USER=<Your GitHub username> yarn deploy
48+
```
49+
50+
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.

docs/v2/babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

0 commit comments

Comments
 (0)