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

[WIP] New Docs landing page #18752

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

[WIP] New Docs landing page #18752

wants to merge 15 commits into from

Conversation

swyxio
Copy link
Contributor

@swyxio swyxio commented Nov 1, 2022

What

new docs page for @Amruta-Ranade

as part of this work, we now also have:

figma
image

current state

light mode
image

dark mode
image

How

add tailwind and react

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Nov 1, 2022
@swyxio
Copy link
Contributor Author

swyxio commented Nov 1, 2022

docs/readme.mdx Outdated
Comment on lines 7 to 53
sectionName: 'Connector Catalog',
list: [
{ displayName: 'Product release stages', link: '/stages'},
{ displayName: 'Open source connectors', link: '/stages'},
{ displayName: 'Cloud connectors', link: '/stages'},
]
},
cloud: {
sectionName: 'Airbyte Cloud',
list: [
{ displayName: 'Start trial', link: '/stages'},
{ displayName: 'Get started', link: '/stages'},
{ displayName: 'Manage Cloud account', link: '/stages'},
]
},
oss: {
sectionName: 'Open Source',
list: [
{ displayName: 'Deploy locally', link: '/stages'},
{ displayName: 'Deploy on Cloud', link: '/stages'},
{ displayName: 'Manage Deployment', link: '/stages'},
]
},
concepts: {
sectionName: 'Core Concepts',
list: [
{ displayName: 'Namespaces', link: '/stages'},
{ displayName: 'Normalization', link: '/stages'},
{ displayName: 'Sync Modes', link: '/stages'},
]
},
contribute: {
sectionName: 'Contribute',
list: [
{ displayName: 'Build a connector', link: '/stages'},
{ displayName: 'Contribute to Code', link: '/stages'},
{ displayName: 'Contribute to Docs', link: '/stages'},
]
},
help: {
sectionName: 'Get Help',
list: [
{ displayName: 'Chat with Support', link: '/stages'},
{ displayName: 'Join us on Community Slack', link: '/stages'},
{ displayName: 'Report issues on GitHub', link: '/stages'},
]
},

This comment was marked as outdated.

@Amruta-Ranade
Copy link
Contributor

This looks incredible, @sw-yx!!! Thank you!!!

docs/readme.mdx Outdated
Comment on lines 9 to 58
export const items = {
catalog: {
sectionName: "Connector Catalog",
list: [
{ displayName: "Product release stages", link: "/stages" },
{ displayName: "Open source connectors", link: "/stages" },
{ displayName: "Cloud connectors", link: "/stages" },
],
},
cloud: {
sectionName: "Airbyte Cloud",
list: [
{ displayName: "Start trial", link: "/stages" },
{ displayName: "Get started", link: "/stages" },
{ displayName: "Manage Cloud account", link: "/stages" },
],
},
oss: {
sectionName: "Open Source",
list: [
{ displayName: "Deploy locally", link: "/stages", flair: "Popular" },
{ displayName: "Deploy on Cloud", link: "/stages" },
{ displayName: "Manage Deployment", link: "/stages" },
],
},
concepts: {
sectionName: "Core Concepts",
list: [
{ displayName: "Namespaces", link: "/stages" },
{ displayName: "Normalization", link: "/stages" },
{ displayName: "Sync Modes", link: "/stages" },
],
},
contribute: {
sectionName: "Contribute",
list: [
{ displayName: "Build a connector", link: "/stages" },
{ displayName: "Contribute to Code", link: "/stages" },
{ displayName: "Contribute to Docs", link: "/stages" },
],
},
help: {
sectionName: "Get Help",
list: [
{ displayName: "Chat with Support", link: "/stages" },
{ displayName: "Join us on Community Slack", link: "/stages" },
{ displayName: "Report issues on GitHub", link: "/stages" },
],
},
};
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sophia-wiley @Amruta-Ranade this is the place to edit the links

Copy link
Contributor

@sophia-wiley sophia-wiley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Feel free to merge the changes :)

docs/.components/Combobox.jsx Outdated Show resolved Hide resolved
@swyxio
Copy link
Contributor Author

swyxio commented Nov 16, 2022

cant merge because the links dont actually go anywhere, i'm waiting for someone to decide what goes where

@Amruta-Ranade
Copy link
Contributor

cant merge because the links dont actually go anywhere, i'm waiting for someone to decide what goes where

Oh, gotcha. @sophia-wiley can you help Shawn with the links? Happy to tag in if you don't have the bandwidth. LMK!

@sophia-wiley
Copy link
Contributor

@sw-yx @Amruta-Ranade I will add the links today :)

@sophia-wiley
Copy link
Contributor

sophia-wiley commented Nov 16, 2022

@sw-yx is there any way that we can combine both search bars? @Amruta-Ranade and I were thinking that it might be confusing for users to have two search bars. We're hoping that the search bar you added could search all the docs.

@swyxio
Copy link
Contributor Author

swyxio commented Nov 21, 2022

that search is provided via https://github.com/cmfcmf/docusaurus-search-local -> it is unfortunately not configurable and i dont see an easy way to combine it unless we fork the code severely, which we'd probably want someone else to own

@Amruta-Ranade
Copy link
Contributor

that search is provided via https://github.com/cmfcmf/docusaurus-search-local -> it is unfortunately not configurable and i dont see an easy way to combine it unless we fork the code severely, which we'd probably want someone else to own

In that case, I think we should remove the connectors search bar and only keep the one in the corner. We're looking into getting help with implementing Algolia search -- we can revisit this when we pick up that project

docs/readme.mdx Outdated Show resolved Hide resolved
docs/readme.mdx Outdated Show resolved Hide resolved
@swyxio
Copy link
Contributor Author

swyxio commented Dec 12, 2022

unable to resolve the yarn lock conflict, think need to reopen this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants