Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: move README to root#1630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

jsjoeio
Copy link
Contributor

@jsjoeiojsjoeio commentedMay 20, 2022•
edited
Loading

We noticed that when you download the repo as a ZIP from GitHub, it
places theREADME.md in the root, which causes the relative links to
break.

By moving it to the root, this will fix that issue.

Testing

  1. Visit branch on GitHub here:https://github.com/coder/coder/tree/1240-bug-readmemd-links-404-when-you-download-repo-as-zip
  2. Click "Download as Zip"
  3. Open in editor aka VS Code
  4. Visit links inREADME.md

Fixes#1240

We noticed that when you download the repo as a ZIP from GitHub, itplaces the `README.md` in the root, which causes the relative links tobreak.By moving it to the root, this will fix that issue.
@jsjoeiojsjoeio self-assigned thisMay 20, 2022
@jsjoeiojsjoeio marked this pull request as ready for reviewMay 20, 2022 16:50
Copy link
Member

@bpmctbpmct left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This LGTM. I actually kinda like how the docs folder doesn't have a root and gets straight to the point. As the project advances more, I can see the need for adocs/README.md too versus the overview/quickstart content on./README.md. Also tagging@khorne3 for thoughts

@bpmctbpmct requested a review fromkhorne3May 20, 2022 16:55
@jsjoeiojsjoeio merged commit0622603 intomainMay 20, 2022
@jsjoeiojsjoeio deleted the 1240-bug-readmemd-links-404-when-you-download-repo-as-zip branchMay 20, 2022 16:56
jsjoeio added a commit that referenced this pull requestMay 20, 2022
It appears we were manually moving the `README.md`. This should have been updated in#1630 but slipped through CI
jsjoeio added a commit that referenced this pull requestMay 20, 2022
It appears we were manually moving the `README.md`. This should have been updated in#1630 but slipped through CI
kylecarbs pushed a commit that referenced this pull requestJun 10, 2022
We noticed that when you download the repo as a ZIP from GitHub, itplaces the `README.md` in the root, which causes the relative links tobreak.By moving it to the root, this will fix that issue.
kylecarbs pushed a commit that referenced this pull requestJun 10, 2022
It appears we were manually moving the `README.md`. This should have been updated in#1630 but slipped through CI
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@bpmctbpmctbpmct approved these changes

@khorne3khorne3Awaiting requested review from khorne3

Assignees

@jsjoeiojsjoeio

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bug: README.md links 404 when you download repo as .ZIP
2 participants
@jsjoeio@bpmct
[8]ページ先頭
©2009-2025 Movatter.jp