Skip to content

Feature Request: Global edit_on_github_branch setting for all versions #6297

Closed

Description

@pllim

Details

cc @bsipocz

Expected Result

"On GitHub -> Edit" option to only allow edit on master branch of the repo. We attempted this at astropy/astropy#9379 but realized that it would not retroactively apply to all the released versions we ever pushed out or archived.

The reason we want this is to prevent contributor to accidentally open a pull request against stale/release branches. We only accept pull request against the master branch.

Is there a global setting that we can use in, say, .readthedocs.yml to control this? Thank you!

Actual Result

Contributor clicked on the "Edit" link and accidentally opened a pull request against the wrong branch in the source code repository.

Activity

  1. stsewd commented on Oct 16, 2019

    @stsewd
    Member

    Sorry, don't think this isn't possible without rebuilding all versions.

    Don't think we have a pattern to edit old versions without rebuilding. You could branch those versions and add the change and push that new version to rtd and add a redirect from the old version to the fixed version.

    Is there a global setting that we can use in, say, .readthedocs.yml to control this?

    We don't plan to add global setting on the configuration file, only per version settings.

  2. pllim commented on Oct 16, 2019

    @pllim
    ContributorAuthor

    Thanks for the quick reply. We'll think of other ways on our end.

  3. bsipocz commented on Oct 16, 2019

    @bsipocz
    Contributor

    @stsewd - The link live however in the same dropdown menu the list of versions, too. Isn't there a way to patch that box in the deployed versions?

  4. stsewd commented on Oct 16, 2019

    @stsewd
    Member

    The link live however in the same dropdown menu the list of versions

    That link is generated dynamically yes, but we always display the link from the same version the user is reading, we are working in making that configurable (but only something like display or not that link, no to change the content).

    You can patch that menu using a custom js file, but that requires re building the versions too.

  5. bsipocz commented on Oct 16, 2019

    @bsipocz
    Contributor

    Being able to not display that link would solve all our headaches, so I'm extremely happy to hear that you're working on making that possible.

  6. reopened this on Oct 16, 2019
  7. stale commented on Nov 30, 2019

    @stale

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

  8. stsewd commented on Dec 2, 2019

    @stsewd
    Member

    @pllim did you reopen the issue to still request the global edit_on_github_branch setting? Or is there something else?

  9. removed
    Status: staleIssue will be considered inactive soon
    on Dec 2, 2019
  10. pllim commented on Dec 2, 2019

    @pllim
    ContributorAuthor

    Yes, I did re-open it due to #6297 (comment) . Sorry for the confusion!

  11. stsewd commented on Dec 2, 2019

    @stsewd
    Member

    @pllim so is the same requests as described in the description? or the one from the comment? (being able to not display the link)

  12. pllim commented on Dec 2, 2019

    @pllim
    ContributorAuthor

    Being able to not display the link would be a workaround solution for lacking a global setting, which I will accept. Does that make sense?

  13. humitos commented on Sep 15, 2023

    @humitos
    Member

    Thanks all for your feedback here.

    We are working a new project called addons which is currently in beta (read more in our blog post at https://blog.readthedocs.com/addons-flyout-menu-beta/) which includes a new completely redesign of the flyout. We are considering these type of configuration there and we have an issue for this: readthedocs/addons#51 and readthedocs/addons#13

    We will exposing the whole data that Read the Docs uses to build the flyout via a javascript event that users can subscript to and render the flyout exactly how they want: adding more section, removing sections, showing the language selector somewhere else, etc.

    Please subscribe there for updates.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions