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

Support for Azure Repositories #1310

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

Conversation

erwin-faceit
Copy link
Contributor

Not everybody has their code stored in Github, and I wanted to add support for the links on the right side to Azure as well.

This PR does that, however, I would suggest a more significant change for source repositories, something along the lines of:

[sourcecontrol]
type = github
repo =
project_repo =

[sourcecontrol.github]

[sourcecontrol.azure]
issue_area =

For now, I lack the time to add support for this, but this would be amazing actually.

The configuration in order to utilize this PR is as following:

[params]
azure_repo =
azure_project_repo =
azure_subdir =
azure_issue_area =

@geriom
Copy link
Collaborator

geriom commented Dec 1, 2022

This is great. Thank you!

Is there a url to preview the Azure links working?

@LisaFC
Copy link
Collaborator

LisaFC commented Jan 6, 2023

Yes, this is great! Should also update the docs in this page: https://www.docsy.dev/docs/adding-content/repository-links/

@erwin-faceit
Copy link
Contributor Author

Is there a url to preview the Azure links working?

No sorry, I'm using this in a non-public project. However, it looks exactly the same as the github links.

@erwin-faceit
Copy link
Contributor Author

Yes, this is great! Should also update the docs in this page: https://www.docsy.dev/docs/adding-content/repository-links/

Agreed, done.

@LisaFC
Copy link
Collaborator

LisaFC commented Jan 6, 2023

Docs LGTM, @geriom do you want to do a final check before approval?

@adlerzei
Copy link

adlerzei commented Feb 2, 2024

Any updates here? I would very much appreciate this change in a new version of Docsy.

@erwin-faceit
Copy link
Contributor Author

Updated to the latest version of docsy. Demo can be seen (with fake links) on the netlify deploy preview.

@smainz
Copy link

smainz commented Apr 23, 2024

Is ths going to be merged?
I made a similar change for repos hosted on gitea (of course using a different code systematic). If this is the way to go, I can offer to do it that way and provide a PR.

This was referenced Apr 23, 2024
@smainz
Copy link

smainz commented Apr 24, 2024

Hi, I tried to push this a bit further in #1941

Config would be:

# 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 = "azure"                                      
  url = "https://dev.azure.com/google/docsy/_git/docsy"
  # 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= "userguide"                                  
  # An optional link to a related project repo. For example, the sibling repository where your product code lives.
  project_url = "https://dev.azure.com/google/docsy/_git/docsy"

# If your partial layout requires additional params, you can set them here.
[params.repo.azure]
  issue_area = "Docsy\\Issues"

smainz added a commit to smainz/docsy that referenced this pull request Apr 24, 2024
smainz added a commit to smainz/docsy that referenced this pull request May 10, 2024
smainz added a commit to smainz/docsy that referenced this pull request May 14, 2024
smainz added a commit to smainz/docsy that referenced this pull request 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

6 participants