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

docs: Update Document organization structure #206

Merged
merged 1 commit into from
Mar 27, 2023
Merged

docs: Update Document organization structure #206

merged 1 commit into from
Mar 27, 2023

Conversation

harshanarayana
Copy link
Contributor

Closes #192

Discussion Items

  • How do we re structure README from inside the examples ?

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 25, 2023
@k8s-ci-robot k8s-ci-robot added the sig/testing Categorizes an issue or PR as relevant to SIG Testing. label Feb 25, 2023
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 25, 2023
@harshanarayana
Copy link
Contributor Author

@vladimirvivien to help discuss the re-grouping of Examples document, I have done it for two files. Wonder what would be the best way to org them

vladimirvivien
vladimirvivien reviewed Mar 1, 2023
View reviewed changes
Copy link
Contributor

@vladimirvivien vladimirvivien left a comment

Choose a reason for hiding this comment

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

@harshanarayana apologies for the late reply.
I think you are on the right track.
I don't think you need to move the markdown docs from the examples directory.
For now, you can just copy them into the docs directory as to keep the examples complete.

@harshanarayana
Copy link
Contributor Author

For now, you can just copy them into the docs directory as to keep the examples complete.

You mean keep two copies of it ?

@vladimirvivien
Copy link
Contributor

@harshanarayana or keep a README.md in examples that links to where the respective example is documented. That way, if I browse from example directory I can get back to documentation about example.

ShwethaKumbla
ShwethaKumbla reviewed Mar 5, 2023
View reviewed changes
Copy link
Member

@ShwethaKumbla ShwethaKumbla left a comment

Choose a reason for hiding this comment

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

LGTM

@harshanarayana
Copy link
Contributor Author

That way, if I browse from example directory I can get back to documentation about example.

I thought I can do this easily and created a few symlinks. Seems like github won't redirect you to the symlink location if you click on the file :( It just show the path for which the current file links to. (The changes are pushed to the branch for now, I will revert them. Leaving them for now just to show you what it looks like.)

Shall I add a section on the docs/README.md that links you to different set of Examples ? cc @vladimirvivien

vladimirvivien
vladimirvivien reviewed Mar 17, 2023
View reviewed changes
Copy link
Contributor

@vladimirvivien vladimirvivien left a comment

Choose a reason for hiding this comment

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

Hi @harshanarayana
Apologies for the late reply.
I have added a comment. I think it's almost there.

docs/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

@harshanarayana Hi 👋
Please add a table of content here that links to the different sections. That way, when a user clicks on docks directory, the list of available content will be displayed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ack. Pushing the changes now.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 20, 2023
vladimirvivien
vladimirvivien reviewed Mar 25, 2023
View reviewed changes
Copy link
Contributor

@vladimirvivien vladimirvivien left a comment

Choose a reason for hiding this comment

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

@harshanarayana I have one question. Other than that, I think this is ready to go.

docs/README.md Outdated
- [Multi Cluster Tests](#multi-cluster-tests)
- [Third Party Integration](#third-party-integration)


# Go E2E Test Framework for Kubernetes
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @harshanarayana this line seems to have moved to line 13. I think It is the title and should be at the top, correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

/Ack. You are right. Let me re order that bit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. PTAL when possible @vladimirvivien

@harshanarayana
docs: update doc organization strcture for easy access
17d3b02 
docs: enable TOC for easy navigation

docs: enable TOC for easy navigation
vladimirvivien
vladimirvivien approved these changes Mar 27, 2023
View reviewed changes
Copy link
Contributor

@vladimirvivien vladimirvivien left a comment

Choose a reason for hiding this comment

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

Thanks @harshanarayana

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 27, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: harshanarayana, vladimirvivien

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

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [harshanarayana,vladimirvivien]

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

@k8s-ci-robot k8s-ci-robot merged commit 3f10c38 into kubernetes-sigs:main Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ShwethaKumbla ShwethaKumbla ShwethaKumbla left review comments

@vladimirvivien vladimirvivien vladimirvivien approved these changes

Assignees

@vladimirvivien vladimirvivien

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

e2e-framework project documentation site
4 participants
@harshanarayana @vladimirvivien @k8s-ci-robot @ShwethaKumbla