search

common-workflow-language / user_guide

The CWL v1.0 - v1.2 user guide
http://www.commonwl.org/user_guide/
Other
42 stars 67 forks source link

Check for empty pages #336

Open jasonlam0627 opened 1 year ago

jasonlam0627 commented 1 year ago

user_guide/cwl/sphinx/init.py user_guide/src/LICENSE.md user_guide/pyproject.toml user_guide/src/episodes.md is removed user_guide/src/setup.md is removed

and the page user_guide/src/introduction/index.md is just direct to the file inside ~/introduction maybe it can be rename to readme.md

swzCuroverse commented 1 year ago

@jasonlam0627 can you give me a bit more context?

swzCuroverse commented 1 year ago

I think these are placeholders. @kinow do you know which one of these are placeholders (and so need a ticket to create) and which can be safely removed?

swzCuroverse commented 1 year ago

user_guide/src/episodes.md is removed user_guide/src/setup.md is removed

Have been kept to ensure the old links still work -- I think it says that on the page.

swzCuroverse commented 1 year ago

@kinow or @mr-c thoughts on this one?

kinow commented 1 year ago

I remember at first I left the pages while testing to make sure the links were not broken. Later I found out that it would be simpler to move content from sections and add redirects using Sphinx. Can't recall if there's any special reason for leaving these files behind.

If someone could test removing them and verifying if we already have something in Sphinx configuration to prevent 404's, or if we can add something there, then +1 to the removal of these empty/old pages.

Mackenzie-OO7 commented 1 year ago

@kinow I tested removing user_guide/pyproject.toml and moving the contents in user_guide/LICENSE.md to user_guide/src/LICENSE.md, then deleting user_guide/LICENSE.md and all the links still work.

kinow commented 1 year ago

@kinow I tested removing user_guide/pyproject.toml and moving the contents in user_guide/LICENSE.md to user_guide/src/LICENSE.md, then deleting user_guide/LICENSE.md and all the links still work.

Got it! I think pyproject.toml and LICENSE.md are supposed to stay in the root directory. LICENSE.md is used by GitHub and most devs will look for it at the root dir. Maybe we can just reference it in the site without moving it (assuming we need to). The toml file is for Python packaging, see

Although that could change in the future, see

So I think we should focus on the empty pages in the src directory only, for now :+1: