Skip to content
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.

"Edit this page" link missing for pages #252

Open
philwo opened this issue Jun 15, 2020 · 4 comments
Open

"Edit this page" link missing for pages #252

philwo opened this issue Jun 15, 2020 · 4 comments

Comments

@philwo
Copy link
Member

philwo commented Jun 15, 2020

I wanted to edit this page: https://bazel.build/maintaining/maintainers-guide.html

But it doesn't have an "Edit this page" link, which makes it hard to do so.

In contrast, other sites like e.g. https://docs.bazel.build/versions/3.2.0/bazel-overview.html have that link. Can we add it to the other pages, too?

@jin
Copy link
Member

jin commented Jun 15, 2020

Yep, you can do that by adapting this snippet from docs.bazel.build for this website:

https://github.com/bazelbuild/bazel/blob/240cbff44c967dbc9e50f9dbeb99fbd49c82ed5a/site/_layouts/documentation.html#L369-L396

@philwo
Copy link
Member Author

philwo commented Jun 15, 2020

Thanks! I'll have a look! 😃 I love this feature.

@aiuto
Copy link
Contributor

aiuto commented Jun 15, 2020

Why would we have an edit section on the versioned docs? When we have multiple release tracks going, we would have to edit back in the correct branch, not at head. This seems potentially error prone unless you can only edit master.

That issue aside, is it really great to have easy edit if we do not have easy preview and dead link testing? I find that unless I can stage the site and examine it I don't trust the edits to the markdown.

@meisterT
Copy link
Member

I really like the edit links where they are available. If nothing else, they give me a clear signal which source file this was generated from.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants