BrightspaceUI / core

A collection of accessible, free, open-source web components for building Brightspace applications.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Links to source from the Daylight site?

cgordon-d2l opened this issue · comments

I have often found it helpful to look at source for a component that I need to subclass or try to figure out an unexpected interaction. Since this site is dynamically created from github, is it possible to have a link to the github repo where the code lives?

I think there are? There's the "suggest an edit" link which takes you to the source README and below that there's a link to the repo:

Screen Shot 2022-01-27 at 9 31 20 AM

That didn't jump out at me as as link to source. The edit link looks like a Wiki Edit link which would make me think it will fix something on this page.

There is a line on the splash page that the site is dynamically generated, but I don't feel that people read those things. I didn't until I just went back looking for it.

The edit link takes you here https://github.com/BrightspaceUI/core/edit/main/components/button/README.md, but I think a better place would be here https://github.com/BrightspaceUI/core/edit/main/components/button. There's a link to make an edit from there:
image

Maybe a footer tag with something like "View the source or suggest an edit here"

Thanks for raising this Chris! We are planning on having an explicit link to the repository on each component page -- this is coming really soon :)

Keep the ideas/feedback coming!

A little background. I just spent way too many hours trying to find the implementation for the Legacy Page control. The control for HubPage is in HubPage.cs, the control for SpokePage is in SpokePage.cs, but the control for Page is D2LPageControl.cs. This was difficult to track down.

There are three different frameworks we have for UI's in C# - Legacy, MVC, and now Daylight. I often have trouble finding source for UI controls because there are plugins(?) in Visual Studio that obscure those connections. Having something direct and clear might be helpful down the line.

Absolutely! I find it confusing as well. We hope to surface secondary information about equivalent MVC/Legacy controls on the Daylight site as well, one day (ie- is this d2l-menu control available in MVC? What's it called/where do I find it?)

I think this has been addressed -- the Daylight site now has text that reads "To see the code, check it out on GitHub:" with a link to the code. I'm going to close this but feel free to chat more with Jeff if you disagree.