search

keptn-sandbox / new-keptn-docs-engine

GSoC 2022 Project: New Documentation Site Engine
https://keptn-experimental-docs-site.netlify.app/
Apache License 2.0
6 stars 2 forks source link

Should I enable `editUrl`? #13

Closed iamrajiv closed 2 years ago

iamrajiv commented 2 years ago

Description

editUrl is a base URL to edit your site. The final URL is computed by editUrl + relativeDocPath. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links.

As of now, I have disabled it because the docs will be pulled from another repository so even if editUrl is enabled it won't be useful I feel.

After enabling editUrl field it will look like this on the page:

Screenshot 2022-07-28 at 11 33 49 PM
mehabhalodiya commented 2 years ago

For more, go over through Slack discussion: https://keptn.slack.com/archives/C017T4KUAG3/p1659018207268779

vadasambar commented 2 years ago

It'd be nice if we could enable Edit button on docs which aren't pulled from other repos and disable it on the docs pulled from other repos. Sounds like a nice thing to have if we get it right,