diff --git a/catalog/breakfast/breakfast.page.yaml b/catalog/breakfast/breakfast.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/catalog/breakfast/breakfast.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/catalog/breakfast/sidebars.yaml b/catalog/breakfast/sidebars.yaml new file mode 100644 index 00000000..7a66c4d2 --- /dev/null +++ b/catalog/breakfast/sidebars.yaml @@ -0,0 +1 @@ +- page: ./breakfast.page.yaml diff --git a/catalog/dinner/dinner.page.yaml b/catalog/dinner/dinner.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/catalog/dinner/dinner.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/catalog/dinner/sidebars.yaml b/catalog/dinner/sidebars.yaml new file mode 100644 index 00000000..cf1e4ea1 --- /dev/null +++ b/catalog/dinner/sidebars.yaml @@ -0,0 +1 @@ +- page: ./dinner.page.yaml diff --git a/catalog/games.mdx b/catalog/games.mdx new file mode 100644 index 00000000..2e74f5b7 --- /dev/null +++ b/catalog/games.mdx @@ -0,0 +1,27 @@ +--- +title: Games APIs +description: Games APIs +--- + +import { WideTile, Flex } from '@redocly/developer-portal/ui'; + +# Games APIs + +The Games APIs entertain. + +Prerequisites +- Good attitude + +
+ + + The hardest game + + + The lightest game + + + The sharpest game + + +
diff --git a/catalog/index.mdx b/catalog/index.mdx new file mode 100644 index 00000000..bbb8cfcf --- /dev/null +++ b/catalog/index.mdx @@ -0,0 +1,32 @@ +--- +title: API catalog +description: Our API catalog is composed of dozens of microservices organized into categories. +--- + +import { WideTile, Flex } from '@redocly/developer-portal/ui'; + +# API catalog + +Welcome to a sample API catalog. + +There are many ways to organize information in Redocly. + +This pull request demonstrates: +- separated sidebars +- combined sidebars +- drilldown sidebars + +This catalog view is a combination of combined sidebars and separate sidebars. + +Select a category such as games, and then select an API. + +
+ + + Entertainment + + + Nutrition and energy + + +
diff --git a/catalog/lunch/lunch.page.yaml b/catalog/lunch/lunch.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/catalog/lunch/lunch.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/catalog/lunch/sidebars.yaml b/catalog/lunch/sidebars.yaml new file mode 100644 index 00000000..2907dc6b --- /dev/null +++ b/catalog/lunch/sidebars.yaml @@ -0,0 +1 @@ +- page: ./lunch.page.yaml diff --git a/catalog/meals.mdx b/catalog/meals.mdx new file mode 100644 index 00000000..867e966a --- /dev/null +++ b/catalog/meals.mdx @@ -0,0 +1,31 @@ +--- +title: Meals APIs +description: Meals APIs +--- + +import { WideTile, Flex } from '@redocly/developer-portal/ui'; + +# Meals APIs + +The Meals APIs satisfy hunger. + +Prerequisites +- Mouth +- Food + +
+ + + The most important meal of the day + + + Mid-day meal + + + End the day with a dinner + + + Recharge in between meals + + +
diff --git a/catalog/sidebars.yaml b/catalog/sidebars.yaml new file mode 100644 index 00000000..b739a750 --- /dev/null +++ b/catalog/sidebars.yaml @@ -0,0 +1,3 @@ +- page: index.mdx +- page: games.mdx +- page: meals.mdx diff --git a/catalog/snacks/sidebars.yaml b/catalog/snacks/sidebars.yaml new file mode 100644 index 00000000..c78367c4 --- /dev/null +++ b/catalog/snacks/sidebars.yaml @@ -0,0 +1 @@ +- page: ./snacks.page.yaml diff --git a/catalog/snacks/snacks.page.yaml b/catalog/snacks/snacks.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/catalog/snacks/snacks.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/combined/index.md b/combined/index.md new file mode 100644 index 00000000..e4cbd11c --- /dev/null +++ b/combined/index.md @@ -0,0 +1,15 @@ +# Combined sidebars + +This puts multiple APIs into a single visible sidebar. + +```yaml +combined: + - page: combined/index.md + - page: combined/rock.page.yaml + - page: combined/paper.page.yaml + - page: combined/scissors.page.yaml +``` + +:::note Pagination +We've paginated the rock, paper, and scissors APIs differently as well. +::: diff --git a/combined/paper.page.yaml b/combined/paper.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/combined/paper.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/combined/rock.page.yaml b/combined/rock.page.yaml new file mode 100644 index 00000000..238acd89 --- /dev/null +++ b/combined/rock.page.yaml @@ -0,0 +1,10 @@ +type: reference-docs +definitionId: rock +settings: + pagination: none + generateCodeSamples: + languages: + - lang: curl + - lang: Go + - lang: PHP + - lang: Ruby diff --git a/combined/scissors.page.yaml b/combined/scissors.page.yaml new file mode 100644 index 00000000..f413d79d --- /dev/null +++ b/combined/scissors.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: scissors +settings: + pagination: item + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/drilldown/index.md b/drilldown/index.md new file mode 100644 index 00000000..d7680b8c --- /dev/null +++ b/drilldown/index.md @@ -0,0 +1,33 @@ +# Drilldown style of sidebars + +This shows the drilldown style of sidebars. + +Notice that the `/*` is appended to the `rock.page.yaml` and `paper.page.yaml` files to avoid an extra group. +We remove the `/*` from the `scissors.page.yaml` file so you can see the difference. + +```yaml +drilldown-style: + - page: drilldown/index.md + - group: Rock + menuStyle: drilldown + icon: images/rock.png + sublabel: Rock API docs + pages: + - page: openapi/rock.page.yaml/* + - group: Paper + menuStyle: drilldown + icon: images/paper.png + sublabel: Paper API docs + pages: + - page: openapi/paper.page.yaml/* + - group: Scissors + menuStyle: drilldown + icon: images/scissors.png + sublabel: Scissors API docs + pages: + - page: openapi/scissors.page.yaml +``` + +:::note Pagination +We've paginated the rock, paper, and scissors APIs differently as well. +::: diff --git a/drilldown/paper.page.yaml b/drilldown/paper.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/drilldown/paper.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/drilldown/rock.page.yaml b/drilldown/rock.page.yaml new file mode 100644 index 00000000..238acd89 --- /dev/null +++ b/drilldown/rock.page.yaml @@ -0,0 +1,10 @@ +type: reference-docs +definitionId: rock +settings: + pagination: none + generateCodeSamples: + languages: + - lang: curl + - lang: Go + - lang: PHP + - lang: Ruby diff --git a/drilldown/scissors.page.yaml b/drilldown/scissors.page.yaml new file mode 100644 index 00000000..f413d79d --- /dev/null +++ b/drilldown/scissors.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: scissors +settings: + pagination: item + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/images/paper.png b/images/paper.png new file mode 100644 index 00000000..28427938 Binary files /dev/null and b/images/paper.png differ diff --git a/images/rock.png b/images/rock.png new file mode 100644 index 00000000..35114410 Binary files /dev/null and b/images/rock.png differ diff --git a/images/scissors.png b/images/scissors.png new file mode 100644 index 00000000..3a7c1b03 Binary files /dev/null and b/images/scissors.png differ diff --git a/index.mdx b/index.mdx index 192157f2..2cee2a3b 100644 --- a/index.mdx +++ b/index.mdx @@ -18,11 +18,9 @@ import { NavBar, } from '@redocly/developer-portal/ui'; -import icon1 from './images/icon1.png'; -import launchFastIcon from './images/launch-fast.svg'; -import icon3 from './images/icon3.png'; -import bookManagementIcon from './images/book-management.svg'; -import foundOrPrivate from './images/found-or-private.svg'; +import rock from './images/rock.png'; +import paper from './images/paper.png'; +import scissors from './images/scissors.png'; export default LandingLayout; @@ -44,26 +42,17 @@ export default LandingLayout; - Create your developer portal today! + Browse our API catalog today! - - Lorem ipsum dolor sit amet, pri putent oportere quaerendum in, ea mea justo invenire - aliquando. Usu modo suavitate ea. Et sed labitur epicurei adipiscing. Nibh zril labitur - an usu.Lorem ipsum dolor sit amet, pri putent oportere quaerendum in, ea mea justo - invenire aliquando. Usu modo suavitate ea. Et sed labitur epicurei adipiscing. Nibh zril - labitur an usu.Lorem ipsum dolor sit amet, pri putent oportere quaerendum in, ea mea - justo invenire aliquando. Usu modo suavitate ea. Et sed labitur epicurei adipiscing. + + This is the Rock API. It thinks it is better than the Scissors API. But it has to watch out for paper. - - Lorem ipsum dolor sit amet, pri putent oportere quaerendum in, ea mea justo invenire - aliquando. Usu modo suavitate ea. Et sed labitur epicurei adipiscing. Nibh zril labitur - an usu. + + The Paper API frightens the Rock API. - - Lorem ipsum dolor sit amet, pri putent oportere quaerendum in, ea mea justo invenire - aliquando. Usu modo suavitate ea. Et sed labitur epicurei adipiscing. Nibh zril labitur - an usu. + + The Scissors API is great as long as it stays away from the Rock API. {/* diff --git a/openapi/paper.page.yaml b/openapi/paper.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/openapi/paper.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/openapi/rock.page.yaml b/openapi/rock.page.yaml new file mode 100644 index 00000000..238acd89 --- /dev/null +++ b/openapi/rock.page.yaml @@ -0,0 +1,10 @@ +type: reference-docs +definitionId: rock +settings: + pagination: none + generateCodeSamples: + languages: + - lang: curl + - lang: Go + - lang: PHP + - lang: Ruby diff --git a/openapi/scissors.page.yaml b/openapi/scissors.page.yaml new file mode 100644 index 00000000..f413d79d --- /dev/null +++ b/openapi/scissors.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: scissors +settings: + pagination: item + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/separated/index.md b/separated/index.md new file mode 100644 index 00000000..61935eef --- /dev/null +++ b/separated/index.md @@ -0,0 +1,29 @@ +# Separate sidebars + +This makes separate sidebars (all within a single `sidebars.yaml` file). + +Notice we use the `/*` to eliminate one grouping level in the scissors and rock APIs. +You will visually see the difference between those and the paper API. + +```yaml +## different sidebars +rock: + - page: separated/rock-quickstart.md + - page: separated/rock.page.yaml/* +paper: + - page: separated/paper.page.yaml +scissors: + - page: separated/scissors.page.yaml/* + +``` + +Use these links to visit those APIs: + +- [Rock](./rock-quickstart.md) +- [Paper](./paper.page.yaml) +- [Scissors](./scissors.page.yaml) + + +:::note Pagination +We've paginated the rock, paper, and scissors APIs differently as well. +::: diff --git a/separated/paper.page.yaml b/separated/paper.page.yaml new file mode 100644 index 00000000..50e3551c --- /dev/null +++ b/separated/paper.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: paper +settings: + pagination: section + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/separated/rock-quickstart.md b/separated/rock-quickstart.md new file mode 100644 index 00000000..2105e705 --- /dev/null +++ b/separated/rock-quickstart.md @@ -0,0 +1,3 @@ +# Rock Quickstart + +This is a quickstart for the Rock API. diff --git a/separated/rock.page.yaml b/separated/rock.page.yaml new file mode 100644 index 00000000..238acd89 --- /dev/null +++ b/separated/rock.page.yaml @@ -0,0 +1,10 @@ +type: reference-docs +definitionId: rock +settings: + pagination: none + generateCodeSamples: + languages: + - lang: curl + - lang: Go + - lang: PHP + - lang: Ruby diff --git a/separated/scissors.page.yaml b/separated/scissors.page.yaml new file mode 100644 index 00000000..f413d79d --- /dev/null +++ b/separated/scissors.page.yaml @@ -0,0 +1,12 @@ +type: reference-docs +definitionId: scissors +settings: + pagination: item + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: C# + - lang: Java diff --git a/sidebars.yaml b/sidebars.yaml index 384ad8e0..0dbaebe8 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -69,3 +69,39 @@ training: alternative: - page: developer-portal/sidebar-alternative.md label: Alternative sidebar example + +## different sidebars +rock: + - page: separated/rock-quickstart.md + - page: separated/rock.page.yaml/* +paper: + - page: separated/paper.page.yaml +scissors: + - page: separated/scissors.page.yaml/* + +combined: + - page: combined/index.md + - page: combined/rock.page.yaml + - page: combined/paper.page.yaml + - page: combined/scissors.page.yaml + +drilldown-style: + - page: drilldown/index.md + - group: Rock + menuStyle: drilldown + icon: images/rock.png + sublabel: Rock API docs + pages: + - page: drilldown/rock.page.yaml/* + - group: Paper + menuStyle: drilldown + icon: images/paper.png + sublabel: Paper API docs + pages: + - page: drilldown/paper.page.yaml/* + - group: Scissors + menuStyle: drilldown + icon: images/scissors.png + sublabel: Scissors API docs + pages: + - page: drilldown/scissors.page.yaml diff --git a/siteConfig.yaml b/siteConfig.yaml index b43cd9fe..3bfbdca5 100644 --- a/siteConfig.yaml +++ b/siteConfig.yaml @@ -1,4 +1,4 @@ -meta: +seo: title: Redocly Training description: The best API documentation generator ever. siteUrl: https://developer-portal-starter.redoc.ly @@ -15,6 +15,10 @@ toc: enable: true oasDefinitions: petstore: ./openapi/petstore.yaml + rock: https://api.redoc.ly/registry/redocly/Demo%20Rock/1.0.0/bundle/rock-paper-scissors/openapi.yaml + paper: https://api.redoc.ly/registry/redocly/Demo%20Paper/1.0.0/bundle/rock-paper-scissors/openapi.yaml + scissors: https://api.redoc.ly/registry/redocly/Demo%20Scissors/1.0.0/bundle/rock-paper-scissors/openapi.yaml + # add links to definitions in our API registry by using a fully qualified URL. stylesheets: - https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700&display=swap @@ -30,14 +34,22 @@ nav: - label: Training exercises page: developer-portal/index.md - - label: External docs - icon: ./images/redocly-icon-white.png - href: https://redoc.ly/docs/developer-portal/introduction/ + - label: Drilldown sidebars + page: drilldown/index.md + + - label: Combined sidebars + page: combined/index.md + + - label: Separated sidebars + page: separated/index.md + + - label: API catalog + page: catalog/index.mdx - search: true footer: - copyrightText: Copyright © Redocly 2019-2021. All right reserved. + copyrightText: Copyright © Redocly 2019-2022. All right reserved. columns: - group: Legal items: