Skip to content

Bug: README.md links 404 when you download repo as .ZIP #1240

Closed

Description

@sharkymark

OS Information

  • coder --version: 0.5.1

Steps to Reproduce

Open README.md file in preview mode or as RAW code. See the list of md files:

Documentation

Expected

Clicking on each of these md files should open them.

Actual

The files are missing.

Logs

Screenshot

Screen Shot 2022-05-01 at 7 15 47 AM

Activity

  1. bpmct commented on May 3, 2022

    @bpmct
    Member

    Ah I see the issue. You can preview this from the root level and the nested ./docs, which are different paths.

  2. self-assigned this
    on May 3, 2022
  3. added this to the V2 Beta milestone on May 4, 2022
  4. modified the milestones: V2 Beta, Community MVP on May 5, 2022
  5. misskniss commented on May 5, 2022

    @misskniss

    Hey team! Please add your planning poker estimate with ZenHub @jsjoeio @bpmct

  6. bpmct commented on May 5, 2022

    @bpmct
    Member

    @jsjoeio @mtm20176 I'm not able to reproduce this... Am I missing something?

    Screen.Recording.2022-05-05.at.5.29.16.PM.mov
  7. sharkymark commented on May 13, 2022

    @sharkymark
    ContributorAuthor

    @bpmct I responded on Discord. We (@khorne3 too) see this when we install the repo locally. Your video above is just at the web site repo.

  8. bpmct commented on May 16, 2022

    @bpmct
    Member

    This error occurs when you go onto the repo page and "Download as ZIP." Then, the README.md is placed in the root directory instead of docs/README.md and links don't work.

    After chatting in discord a bit, we have a proposed solution: move docs/README.md to ./README.md and potentially create a docs/README.md with additional documentation instead of getting started content

  9. changed the title [-]Bug: README.md has references to other md files but they are not included in the repo. 📑👻[/-] [+]Bug: README.md links 404 when you download repo as .ZIP[/+] on May 16, 2022
  10. bpmct commented on May 16, 2022

    @bpmct
    Member

    @misskniss I don't think this is high priority anymore as it only occurs when a user downloads the repo as a .zip. However, the proposed solution is simple enough. I assigned this to myself

  11. assigned and unassigned on May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsArea: coder.com/docs

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions