Skip to content

Conversation

@xonas1101
Copy link

πŸ“Œ Fixes

Fixes #780


πŸ“ Summary of Changes

Adds two clear actions to documentation pages:

  • View Source – opens the source file on GitHub
  • Open Issue – opens a prefilled GitHub issue for the page

This replaces the previous edit-only icon with clearer, safer actions.


Changes Made

  • Updated docs UI with View Source and Open Issue buttons
  • Refactored ...
  • Fixed ...
  • Added tests for ...

Checklist

Please ensure the following before submitting your PR:

  • I have reviewed the project's contribution guidelines.
  • I have written unit tests for the changes (if applicable).
  • I have updated the documentation (if applicable).
  • I have tested the changes locally and ensured they work as expected.
  • My code follows the project's coding standards.

Screenshots or Logs (if applicable)


πŸ‘€ Reviewer Notes

  • This PR adds View Source and Open Issue buttons only.
  • I didn’t add the PR button yet and would like guidance on what it should do.

@kubestellar-prow kubestellar-prow bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Jan 17, 2026
@kubestellar-prow
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign mavrick-1 for approval. For more information see the Code Review Process.

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

Details 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

@github-actions
Copy link
Contributor

Welcome to KubeStellar! πŸš€ Thank you for submitting this Pull Request.

Before your PR can be merged, please ensure:

βœ… DCO Sign-off - All commits must be signed off with git commit -s to certify the Developer Certificate of Origin

βœ… PR Title - Must start with an emoji: ✨ (feature), πŸ› (bug fix), πŸ“– (docs), 🌱 (infra/tests), ⚠️ (breaking change)

Getting Started with KubeStellar:

Contributor Resources:


🌟 Help KubeStellar Grow - We Need Adopters!

Our roadmap is driven entirely by adopter feedback. Whether you're using KubeStellar yourself or know someone who could benefit from multi-cluster Kubernetes:

πŸ“‹ Take our Multi-Cluster Survey - Share your use cases and help shape our direction!


A maintainer will review your PR soon. Feel free to ask questions in the comments or on Slack!

@kubestellar-prow kubestellar-prow bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 17, 2026
@kubestellar-prow kubestellar-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 17, 2026
@kubestellar-prow
Copy link

Hi @xonas1101. Thanks for your PR.

I'm waiting for a kubestellar 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.

Details

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-sigs/prow repository.

@netlify
Copy link

netlify bot commented Jan 17, 2026

βœ… Deploy Preview for kubestellar-docs ready!

Built without sensitive environment variables

Name Link
πŸ”¨ Latest commit 27dde79
πŸ” Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/697883be9e75210008199ae9
😎 Deploy Preview https://deploy-preview-796--kubestellar-docs.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@xonas1101 xonas1101 changed the title Added docs source actions (view source filem, open issue) ✨ Added docs source actions (view source filem, open issue) Jan 17, 2026
@xonas1101 xonas1101 changed the title ✨ Added docs source actions (view source filem, open issue) ✨ Added docs source actions (view source file, open issue) Jan 17, 2026
@kubestellar-prow kubestellar-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 17, 2026
@xonas1101
Copy link
Author

/cc @MikeSpreitzer
I would like to know what the functionality of compose a PR button would be.

@clubanderson
Copy link
Contributor

/ok-to-test

@kubestellar-prow kubestellar-prow 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 Jan 19, 2026
@MikeSpreitzer
Copy link
Contributor

MikeSpreitzer commented Jan 19, 2026

The UI currently has a button that does part of the create-a-PR function. You can see it in the lower right of the following snapshot.

image

Hovering over it produces the following, which looks a bit botched to me.

image

The problem with the existing function is that it creates a branch in the shared repo (github.com/kubestellar/docs) rather than in the contributor's fork. At least, that is what it does when I test it with my regular login --- which has admin access to the shared repo.

@xonas1101
Copy link
Author

Hi @MikeSpreitzer I looked into this, and its basically functional right? I will just format this button like the other two. Also, I'll make the button take the user to /fork endpoint if no fork exists on the user's account. For the admin access accounts, I'll try to find a way to still enforce making changes on the user's fork.
For non-admin users, the behavior is fine. A branch is made in the user's fork automatically, named patch-1, patch-2 etc.

@github-actions github-actions bot removed the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jan 20, 2026
@kubestellar-prow
Copy link

@xonas1101: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kubestellar-docs-markdown-lint b3925bb link true /test pull-kubestellar-docs-markdown-lint
pull-kubestellar-docs-build b3925bb link true /test pull-kubestellar-docs-build
pull-kubestellar-docs-test b3925bb link true /test pull-kubestellar-docs-test
pull-kubestellar-docs-verify b3925bb link true /test pull-kubestellar-docs-verify

Full PR test history

Details

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-sigs/prow repository. I understand the commands that are listed here.

@xonas1101 xonas1101 force-pushed the feat-docs-source-actions branch from b3925bb to 217c788 Compare January 20, 2026 12:23
@kubestellar-prow kubestellar-prow bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 20, 2026
@xonas1101
Copy link
Author

/retest

@kubestellar-prow
Copy link

@xonas1101: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

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-sigs/prow repository.

@xonas1101 xonas1101 changed the title ✨ Added docs source actions (view source file, open issue) ✨ Added docs source actions (view source file, open issue, compose PR) Jan 20, 2026
@xonas1101
Copy link
Author

@clubanderson @MikeSpreitzer I have performed the changes for Compose a PR button, I have checked with an account that has a fork of ks/docs, and one that does not have a fork already. All that's left is to see for the accounts that have admin access. Please lmk if further changes are needed, or we have the desired functionality.

@xonas1101
Copy link
Author

@MikeSpreitzer @clubanderson I think the PR is currently blocked on /ok-to-test after the latest changes. Can you please add the ok-to-test label when you have the time? Thanks!

@kubestellar-prow kubestellar-prow bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 23, 2026
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
Signed-off-by: xonas1101 <aarushsingh1305@gmail.com>
@xonas1101 xonas1101 force-pushed the feat-docs-source-actions branch from 217c788 to 27dde79 Compare January 27, 2026 09:22
@kubestellar-prow kubestellar-prow bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 27, 2026
@xonas1101
Copy link
Author

@MikeSpreitzer @clubanderson I have resolved the merge conflicts popping up in EditPageLink.tsx.
Can you please check out whether the desired behavior is achieved for accounts that have write access into the main branch.
Would love your feedback whenever you have the chance. Thanks!

@xonas1101
Copy link
Author

As a follow-up issue, we maybe can remove EditPageLink.tsx after this PR, since all the work done in that file is now moved to DocsSourceActions.tsx with extra features and a bit refactoring.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. frontend size/L Denotes a PR that changes 100-499 lines, ignoring generated files. typescript

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature: proper generic buttons on each documentation page

3 participants