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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉 Updated README.md links #2255

Merged
merged 1 commit into from
Oct 25, 2022
Merged

Conversation

eranco74
Copy link
Contributor

@eranco74 eranco74 commented Oct 24, 2022

Summary

The links to additional documentation (Concepts, Workspaces, etc) are broken, this PR fixes the links path

Signed-off-by: Eran Cohen <eranco@redhat.com>
@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 24, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 24, 2022

Hi @eranco74. Thanks for your PR.

I'm waiting for a kcp-dev member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@hardys
Copy link

hardys commented Oct 24, 2022

/ok-to-test
/cc @avinal looks like this was missed in #2219

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 24, 2022
@avinal
Copy link
Member

avinal commented Oct 24, 2022

Ah indeed missed 馃槄. Now that our documentation site is up, I was thinking about putting links to site pages instead of markdowns. WDYT @hardys?

In case you haven't checked the site yet, please do https://docs.kcp.io/kcp/main

@hardys
Copy link

hardys commented Oct 24, 2022

Ah indeed missed sweat_smile. Now that our documentation site is up, I was thinking about putting links to site pages instead of markdowns. WDYT @hardys?

My only concern with that is we seem to only publish docs for main to the site, so links in release branches will point to main docs, not the (potentially different) docs in each release branch.

Leaving the links to the markdown seems like the simplest solution unless there is a plan to publish per-release docs on the site?

@hardys
Copy link

hardys commented Oct 24, 2022

@eranco74 the PR verifier is failing on this check - I think you'll have to make the PR description a bit more verbose

@avinal
Copy link
Member

avinal commented Oct 24, 2022

I have added the versioned docs mechanism in GitHub Actions. Since this is our first ever docs site so we have only the main ref. But with the next release we will have more versions automatically. The links however can remain pointing to main ref, if we intend to provide the latest docs. The project is developing rapidly so this may be desirable. Later we will make them point to the latest stable version of docs.

@hardys
Copy link

hardys commented Oct 25, 2022

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 25, 2022
Copy link
Contributor

@stevekuznetsov stevekuznetsov left a comment

Choose a reason for hiding this comment

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

Thank you!

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 25, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: stevekuznetsov

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:

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 25, 2022
@openshift-merge-robot openshift-merge-robot merged commit 3a21748 into kcp-dev:main Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants