Show link to source github repo and/or edit this page links ...

[Daniellappv]

We have had requests from people that they want (or visitors) to be able to find the source github repo for their project.

Also i've had experience on KB (knowledgebase) projects that i want an edit this page button so i can quickly edit something.

Tasks

Beta Give feedback

1. Shape the github link item
2. Shape the edit this page part
3. Decide if / when to have bot

Initial creator info (Rufus)

NB: i think we may want to split this into 2 issues for implementation once we have done shaping

Would be nice to have a link to github repo shown somewhere on landing page on project e.g.

Separately - edit this page

Having an "edit this page" link on a page on KB (non-dataset) projects. Would have at bottom of page or something like how mkdocs-material does it (look at how they do it)

[LuisVCSilva]

Problem:

Users and visitors (people that dont have accounts) want to be able to find the source GitHub repo for their project and have an "edit this page" button to quickly make edits.

Appetite:

~ 1 week

Rabbit-holes:

• Ensuring that the "edit this page" button is user-friendly and integrates seamlessly with existing documentation systems (we could make our own wysiwyg editor in the future)
• Handling permissions and access control for the "edit this page" functionality to ensure only authorized users can make edits.

No Gos:

• Overcomplicating the design or implementation, leading to a cluttered user interface.

Solution:

Create a component to show a button with a link to the Github Repository

[olayway]

Handling permissions and access control for the "edit this page" functionality to ensure only authorized users can make edits.

I think this should be a togglable option in site settings. And it should be up to the site owner to make sure the repo is public.

[olayway]

Ensuring that the "edit this page" button is user-friendly and integrates seamlessly with existing documentation systems

I'm not sure I understand this :) It's just a simple button ;) Something like this:

[olayway]

~ 1 week

I think it shouldn't take more than 1 day to implement both, including any required docs updates.

[olayway]

Should the github link go only on dataset pages? Or data story pages too? Should it be togglable too? My guess it yes.

[olayway]

@LuisVCSilva Great start, but your shaping doesn't include the most important part - the "Solution" ;)

[LuisVCSilva]

Hi @olayway, thanks for pointing it out, edits made