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] Add md-book and refactor/organizing docs #298

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

komer3
Copy link
Contributor

@komer3 komer3 commented Jan 17, 2025

General:

  • Have you removed all sensitive information, including but not limited to access keys and passwords?
  • Have you checked to ensure there aren't other open or closed Pull Requests for the same bug/feature/question?

Pull Request Guidelines:

  1. Does your submission pass tests?
  2. Have you added tests?
  3. Are you addressing a single feature in this PR?
  4. Are your commits atomic, addressing one change per commit?
  5. Are you following the conventions of the language?
  6. Have you saved your large formatting changes for a different PR, so we can focus on your work?
  7. Have you explained your rationale for why this feature is needed?
  8. Have you linked your PR to an open issue

@github-actions github-actions bot added the documentation for updates to the documentation in the changelog. label Jan 17, 2025
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.07%. Comparing base (ec8a70a) to head (855b407).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #298   +/-   ##
=======================================
  Coverage   71.07%   71.07%           
=======================================
  Files          12       12           
  Lines        2216     2216           
=======================================
  Hits         1575     1575           
  Misses        490      490           
  Partials      151      151           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@komer3 komer3 changed the title [docs] Refactor and organize the Doc. Add mdbook. [docs] Add md-book and refactor/organizing docs Jan 17, 2025
README.md Outdated Show resolved Hide resolved
@komer3 komer3 marked this pull request as ready for review January 17, 2025 19:55
## Node Networking

### Private Network Requirements
- NodeBalancers require nodes to have private IP addresses
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- NodeBalancers require nodes to have private IP addresses
- NodeBalancers require nodes to have linode specific [private IP addresses](https://techdocs.akamai.com/cloud-computing/docs/managing-ip-addresses-on-a-compute-instance#types-of-ip-addresses)

## Available Examples

1. **[Basic Services](basic.md)**
- HTTP LoadBalancer
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we need to add links here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't need to for mdbook tbh. Just added them incase some is navigating from README in root dir. Should help with navigation a bit?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation for updates to the documentation in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants