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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo links improvements #1941

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

smainz
Copy link

@smainz smainz commented Apr 24, 2024

This refactors the repo links, so it is easier to add new types of repositories.

Current github_* parameters have been deprecated and replaced by these params:

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
[params.repo]
  # The type of forge (allowed values github, azure, gitea)
  # If you enter a different type, you can add a layout/partials/repo-links-<your_type>.html
  # template for rendering links.
  type = "github"                                      
  url = "https://github.com/google/docsy-example" 
  # Uncomment this if your repo does not have "main" as the default branch,
  # or specify a new value if you want to reference another branch in your git links
  branch = "master"                                  
  # Specify a value here if your content directory is not in your repo's root directory
  #subdir = "docs"                                     
  # An optional link to a related project repo. For example, the sibling repository where your product code lives.
  project_url = "https://github.com/google/docsy"

Scope of this PR is:

  • refactor git repo configuration
  • deprecate the current github_* cofiguration (still works, but gives a warning)
  • add support for gitea / forgjo git repos
  • add support for Azure DevOps repos
  • add support for gitlab repos
  • add support for custom repo type
  • update documentation

Copy link

google-cla bot commented Apr 24, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@smainz
Copy link
Author

smainz commented Apr 24, 2024

This is still work in progress, but can be finalized soon by updating the docs and possibly taking the azure repo links from #1310.
@chalin Does this go into the right direction, so time permits for Release .10.0 (#1812)?

This was referenced Apr 24, 2024
@chalin
Copy link
Collaborator

chalin commented Apr 24, 2024

Thanks @smainz. While #1841 is on the radar, I don't think that it will make 0.10.0 -- the release has been delayed much longer than I hoped for already. I'll be working on #1841 and taking a look at this PR as soon as I can, but it might not be before 0.12.0 as the way things are shaping up atm 🤷🏼‍♂️.

@smainz
Copy link
Author

smainz commented Apr 25, 2024

I can try to unify

into one PR

if the authors agree and provide the relevant urls.

Move the old code into 'repo-links-github-deprectaded.html' and
call this partial.
@smainz smainz force-pushed the repo-links-improvements branch 2 times, most recently from d776e07 to a35abb3 Compare May 13, 2024 16:25
@smainz smainz changed the title WIP: Repo links improvements Repo links improvements May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants