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

Feature Request - add Azure Repos links support #794

Open
Tracked by #1841
di9383 opened this issue Dec 6, 2021 · 7 comments
Open
Tracked by #1841

Feature Request - add Azure Repos links support #794

di9383 opened this issue Dec 6, 2021 · 7 comments
Labels
e1-hours enhancement New feature or request

Comments

@di9383
Copy link

di9383 commented Dec 6, 2021

Hi!
As mentioned here GitHub is the only repository that is supported by Repository Links.

Is it possible to add Azure Repos support or at least guide, which files/modules/etc. should be adjusted by one not mature enough with Go but ready to dive in and contribute?

@LisaFC
Copy link
Collaborator

LisaFC commented Dec 6, 2021

Hi there,

Here's the file we use for the repository links, if you want to take a look - you can also override this file for just your own project if you don't want to have to deal yet with all the potential conditionals etc. you'd need to add to the main theme:
https://github.com/google/docsy/blob/master/layouts/partials/page-meta-links.html

@chalin did the most recent work on it so might be able to help at some stage.

@chalin
Copy link
Collaborator

chalin commented Dec 17, 2021

Hi @di9383. Can you provide some examples of the kinds of repo links that you'd need and/or links to a public docs website and the associated Azure repo?

@chalin chalin added enhancement New feature or request needs-info labels Dec 17, 2021
@di9383
Copy link
Author

di9383 commented Dec 18, 2021

Hi @chalin,
thank you for your support.
So basically, if we consider to edit _index.md landing page, this is how url will look like when azure git repo is used:

https://dev.azure.com/<org_name>/<project_name>/_git/<repo_name>?path=/content/en/docs/_index.md

while this is how the same page looks in github:

https://github.com/<org_name>/<repo_name>/edit/master/content/en/docs/_index.md

Also it seems that Azure Repos URL uses the default branch (main or master usually) unless otherwise is set. And if I change the branch it is added in the end, like this:

https://dev.azure.com/<org_name>/<project_name>/_git/<repo_name>?path=%2Fcontent%2Fen%2F_index.md&version=GBmain&_a=contents

So it is rather cumbersome behavior and link composition, but I believe even adding default URL format support is enough for the purpose of functionality these links provide.

@chalin
Copy link
Collaborator

chalin commented Dec 21, 2021

Thanks for those examples. I have a couple of ideas that I'll explore as soon as I can.

@di9383
Copy link
Author

di9383 commented Jan 14, 2022

Hi @chalin. Just for understanding, do you have any timelines for this?

@chalin
Copy link
Collaborator

chalin commented Jan 18, 2022

Hi @di9383 - while I have ideas on how to generalize the repo-links layout, other docsy tasks seem to be more pressing. My hope is to get to this in the first half of the year. If you can get others to upvote this issue, maybe it will get some attention earlier.

@erwin-faceit
Copy link
Contributor

See #1310

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e1-hours enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants