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

docs: extract how-to guides from "Server" page #5768

Merged
merged 3 commits into from
Jun 23, 2020
Merged

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented Jun 18, 2020

As part of our move towards four-quadrant documentation system (see #5549 and #5718), we (@hacksparrow and me) took a look at restructuring Server page and extracted two new how-to guides:

  • Enabling HTTPS (under Deployment)
  • Customizing how OpenAPI spec is served (under a new section REST APIs)

The goal of this work is to explore how to best (re)structure the existing content, so that we can create better user-stories.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@bajtos bajtos added developer-experience Issues affecting ease of use and overall experience of LB users Docs labels Jun 18, 2020
@bajtos bajtos self-assigned this Jun 18, 2020
@bajtos bajtos changed the title Extract how-to guides from "Server" page docs: extract how-to guides from "Server" page Jun 19, 2020
@bajtos bajtos marked this pull request as draft June 19, 2020 15:45
Copy link
Member

@dhmlau dhmlau left a comment

Choose a reason for hiding this comment

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

It's great to see that two sections separated out from the Server page, because it's a common question for users to ask about how to enable https. :)
Please see my comments.

docs/site/sidebars/lb4_sidebar.yml Outdated Show resolved Hide resolved
docs/site/guides/rest/rest-api-guides.md Outdated Show resolved Hide resolved
docs/site/guides/rest/customize-openapi.md Outdated Show resolved Hide resolved
@bajtos bajtos force-pushed the docs/rework-server-page branch from afba0c0 to 4ac69ca Compare June 23, 2020 07:41
@bajtos bajtos marked this pull request as ready for review June 23, 2020 07:45
@bajtos bajtos requested review from hacksparrow and dhmlau June 23, 2020 07:45
@bajtos
Copy link
Member Author

bajtos commented Jun 23, 2020

Rebased on top of the latest master and resolved review comments & todo items.

The PR is ready for final review and landing.

@raymondfeng @dhmlau @hacksparrow PTAL

@hacksparrow
Copy link
Contributor

Not a biggie, left a suggestion. LGTM.

bajtos and others added 3 commits June 23, 2020 16:02
Co-authored-by: Hage Yaapa <captain@hacksparrow.com>
Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Co-authored-by: Hage Yaapa <captain@hacksparrow.com>
Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Add a section with links to How-to guides related to Servers,
to make it easier to find the content we are extracting from Servers
page to elsewhere.

Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
@bajtos bajtos force-pushed the docs/rework-server-page branch from 9871197 to ceff7ab Compare June 23, 2020 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Issues affecting ease of use and overall experience of LB users Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants