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.

Sign up for GitHub

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

Jump to bottom

promote install instructions to top level menu item, enable mkdocs gh action #1681

Merged
merged 4 commits into from
Dec 2, 2020
Merged

promote install instructions to top level menu item, enable mkdocs gh action #1681

merged 4 commits into from
Dec 2, 2020

Conversation

geoffcline
Copy link
Contributor

No description provided.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 23, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @geoffcline!

It looks like this is your first PR to kubernetes-sigs/aws-load-balancer-controller 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/aws-load-balancer-controller has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 23, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: geoffcline
To complete the pull request process, please assign after the PR has been reviewed.
You can assign the PR to them by writing /assign in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@geoffcline
Copy link
Contributor Author

draft new page visible here

https://geoffcline.github.io/aws-load-balancer-controller/install/installation/

@geoffcline
Copy link
Contributor Author

ready for review @M00nF1sh :)

M00nF1sh
M00nF1sh reviewed Nov 24, 2020
View reviewed changes
.github/workflows/mkdocs-deploy.yml Outdated
@@ -0,0 +1,32 @@
# GCLINE@ 23NOV2020
Copy link
Collaborator

Choose a reason for hiding this comment

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

guess this should be amazon's copy right or leave empty :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I meant that more as a "who wrote this" but I can see the confusion, I'll fix

M00nF1sh
M00nF1sh reviewed Nov 24, 2020
View reviewed changes
.github/workflows/mkdocs-deploy.yml Outdated
- name: Checkout master
uses: actions/checkout@v2

- name: Deploy docs
Copy link
Collaborator

Choose a reason for hiding this comment

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

we are using mike to deploy our multi-version docs.
I think we need to have our own actions or update mhausenblas/mkdocs-deploy-gh-pages to support mike.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll take a look at how difficult that would be ... hopefully we can still do CD

@M00nF1sh
Copy link
Collaborator

M00nF1sh commented Nov 24, 2020 •
edited

how about the following layout

Home
Deployment
    Installation Guide
    Configurations
    Subnet Discovery
    Pod Readiness Gate
    Upgrade
        Migrate v1 to v2
User Guide
    Ingress
        ...
    Service
        ...
    TargetGroupBinding
        ...
    Tasks
        ...
Examples
    EchoServer

nice gh actions CI btw 👍

@geoffcline
Copy link
Contributor Author

ok, I can work using that layout tomorrow 👍

@geoffcline
Copy link
Contributor Author

Ok @M00nF1sh - I refactored based on your suggested nav.

I also removed the github action, until I can get an action for mike working.

Thanks!
Geoffrey

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 30, 2020
@M00nF1sh
Copy link
Collaborator

M00nF1sh commented Dec 1, 2020

/lgtm..would you help rebase this.

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 2, 2020
@M00nF1sh
Copy link
Collaborator

M00nF1sh commented Dec 2, 2020

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 2, 2020
@M00nF1sh M00nF1sh merged commit 8db51cb into kubernetes-sigs:main Dec 2, 2020
@geoffcline geoffcline mentioned this pull request Sep 2, 2021
Closed
7 tasks
Timothy-Dougherty pushed a commit to adammw/aws-load-balancer-controller that referenced this pull request Nov 9, 2023
@geoffcline @M00nF1sh @Timothy-Dougherty
promote install instructions to top level menu item, enable mkdocs gh…
97b3841 
… action (kubernetes-sigs#1681)

* refactor install instructions, add new top tab

refactor to add deploy and examples top level nav

* move install materials back

* move how-it-works under home

* update docs to ref v2.1.0 branch

Co-authored-by: Yang Yang <yyyng@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@M00nF1sh M00nF1sh M00nF1sh left review comments

Assignees

@M00nF1sh M00nF1sh

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@geoffcline @k8s-ci-robot @M00nF1sh