docs: move files in docs to Wiki
#2094
Comments
|
Change https://go.dev/cl/400355 mentions this issue: |
|
Change https://go.dev/cl/400356 mentions this issue: |
For golang#2094 Change-Id: Ifdba178d749dad2c9e15428148688e297d1aba14
For golang#2094 Change-Id: I2170fe3755214f1b6390f3292b2a3601797ae359
For #2094 Change-Id: Ifdba178d749dad2c9e15428148688e297d1aba14 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/400355 Reviewed-by: Jamal Carvalho <jamal@golang.org>
For #2094 Change-Id: I2170fe3755214f1b6390f3292b2a3601797ae359 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/400356 Reviewed-by: Suzy Mueller <suzmue@golang.org>
Unlike markdown style links for local md file references, wiki links need to be the url of the wiki pages. In GitHub wiki, links to local md files of file.md form send users to in the local disk and wiki links are different. In GitHub Wiki, if links to local md files send users to raw.github.com pages that serve the raw text content. https://stackoverflow.com/questions/34804531/in-github-wiki-absolute-links-to-markdown-leads-to-raw-githubusercontent To avoid this, rewrite local md file uris included in all the md files in dir. And, call this from github action wiki.yml workflow before pushing to the wiki repo. Fixes golang#2094 Change-Id: Iaeb756a4c14cd98544a1a58ace859b6f48a358ce
|
Change https://go.dev/cl/401194 mentions this issue: |
|
Change https://go.dev/cl/401196 mentions this issue: |
Unlike markdown style links for local md file references, wiki links need to be the url of the wiki pages. In GitHub wiki, links to local md files of file.md form send users to in the local disk and wiki links are different. In GitHub Wiki, if links to local md files send users to raw.github.com pages that serve the raw text content. https://stackoverflow.com/questions/34804531/in-github-wiki-absolute-links-to-markdown-leads-to-raw-githubusercontent To avoid this, rewrite local md file uris included in all the md files in dir. And, call this from github action wiki.yml workflow before pushing to the wiki repo. Updates #2094 Change-Id: Iaeb756a4c14cd98544a1a58ace859b6f48a358ce Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/401194 Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Jamal Carvalho <jamal@golang.org> TryBot-Result: kokoro <noreply+kokoro@google.com> Reviewed-by: Suzy Mueller <suzmue@golang.org>
Wiki page assumes its file name is the title of the page. Remove the redundant title header from the content. We assume the first line of the file that starts with # is the title header. Adjust some .md file contents to work with the heuristic. For #2094 Change-Id: Id873556af8aaf0ae5a06ada073fdbbcd5f44628c Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/401196 Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Jamal Carvalho <jamal@golang.org> TryBot-Result: kokoro <noreply+kokoro@google.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
|
May I make a suggestion? It might be a good idea to make the generated markdown for the Wikis include a custom "Edit on GitHub" link that auto-forks/opens the source markdown for editing. As an example of another organization's approach to the wiki issue, see https://libgdx.com/wiki/ and search for "Edit on GitHub" on that page for an example. It should be possible to have that as the "Edit on GitHub" link in the markdown that's pushed to the GitHub Wiki instead of the generic and non-specific "send a pull request" in the footer. Example: tokio-rs/website#109 I run https://github-wiki-see.page so I'm very aware of the challenges that organizations and individuals have in trying to get their GitHub Wiki content officially indexable. Please let me know if you or your team have any questions. |
As suggested in golang#2094 (comment) Since we rely on GitHub's default wiki feature instead of GH pages or custom hosting sites, options are limited currently. Updates golang#2094 Change-Id: I3090ee79c9794e2b56fc78fa564770266767f3dd
And change the use of https://github.com/golang/vscode-go/blob/master/docs from files in docs directory to relative paths so tools like docs2wiki can translate them consistently. Fixes golang#2094 Change-Id: I185f590d3d48704d648edcf4ad58b9aee5414690
|
Change https://go.dev/cl/412057 mentions this issue: |
|
Change https://go.dev/cl/412055 mentions this issue: |
As suggested in #2094 (comment) Since we rely on GitHub's default wiki feature instead of GH pages or custom hosting sites, options are limited currently. Updates #2094 Change-Id: I3090ee79c9794e2b56fc78fa564770266767f3dd Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/412055 Reviewed-by: Jamal Carvalho <jamal@golang.org>
|
Change https://go.dev/cl/412384 mentions this issue: |
|
Change https://go.dev/cl/412386 mentions this issue: |
|
Integrated platforms across the internet, Domains Registrar, Domains WHOIS Records, Servers Hosting Platform databases system Admin flow |
|
.github/ISSUE_TEMPLATE |
Background
In microsoft/vscode-go#3168 we moved all the contents from Wiki to the
docsdirectory.The rationals behind the move were
With the move, however, we had to give up GitHub's Wiki UI that allows more customization & search &
index options suitable for documentations. Documentation inside the main project repo is not easily
searchable either.
Proposal
Follow the github.com/microsoft/vscode project's wiki page setup. (https://github.com/microsoft/vscode/wiki vs https://github.com/Microsoft/vscode-wiki)
vscode-gorepo'sdocsdirectory.docsdirectory togithub.com/golang/vscode-go.wikirepo.Note
cc @golang/tools-team
EDIT: (2022-04-17) Originally I proposed to have a separate repo to host documentation. But that complicates automated documentation generation with which we wanted to maintain consistency between the current code & the settings. Keeping two separate repositories isn't ideal either. Instead, I changed this proposal to use
docsdirectory as the place we keep all the wiki page contents, and mirror the contents to the wiki page.The text was updated successfully, but these errors were encountered: