Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please change all links to remove broken. #1457

Open
journey2w opened this issue Jun 2, 2021 · 7 comments
Open

Please change all links to remove broken. #1457

journey2w opened this issue Jun 2, 2021 · 7 comments

Comments

@journey2w
Copy link
Contributor

journey2w commented Jun 2, 2021

@piotrekgorny

#1445 was merged to the master branch.

Please resolve broken links by seeing https://docs1.stg.tizen.org/staging/1445.

Mr. Kwon said that SRPOL is in charge of maintenance changed by SRPOL.
It's not resolved in spite of redirection in docs.tizen.org.
docs.tizen.org can redirect the changed path once. However, anyone can change the file name and directory path.
So I asked you.

Some documents of the tizen-docs have changed its location. We created a list of them containing old and new URLs. Once this change is deployed, please create server redirections to ensure that old URLs redirects to proper locations (consider '301 Moved Permanently' http status). We added the list as an attachment to this email (tizen-docs-new-locations.xlsx).

@piotrekgorny
Copy link
Contributor

Dear @journey2w

Could you please describe more about "docs.tizen.org can redirect the changed path once. However, anyone can change the file name and directory path." because I'm not sure if I correctly understand it.

We don't have access to the "docs.tizen.org" server configuration and the configuration of the building the site so we only prepared a list of documents links which were moved.

@smartfoxlab
Copy link

This topic was discussed with @iljooo last year.
It's about configuring server to redirect from old URLs to new URLs. And not about changing current links.

@journey2w
Copy link
Contributor Author

journey2w commented Jun 3, 2021

@piotrekgorny

@iljooo can do just once.

Although docs.tizen.org has config to redirect from the old path to your changed path, the path can be changed by writers. If so the broken link will be created.

For example,

  1. A file is renamed:

    Old New
    /dotnet/guides/LINKA.md /dotnet/guide/LINKAA.md
    /dotnet/guides/SourceA.md /dotnet/guide/SourceA.md
    /dotnet/guides/SourceB.md /dotnet/guide/SourceB.md

    SourceA.md and sourceB.md have a link to LINKA.md as below:

    You can see [the LINKAguide](./LINKA.md).
  2. docs.tizen.org might direct LINKA.md to LINKAA.md.

  3. One of Docs writers can change LINKAA.md to LINKBB.md.
    They will update the link of LINKAA.md to LINKBB.md in their files. Writers don't know LINKA.md redirected LINKAA.md, but they will think LINKA.md and LINKAA.md are different files.

    When Jenkins converts MD files to HTML, the URL is created https://docs.tizen.org/dotnet/guide/LINKAA.
    Although LINKA redirected to LINKBB, https://docs.tizen.org/dotnet/guide/AA' will be broken because https://docs.tizen.org/dotnet/guide/LINKAA' doesn't exist anymore. The new URL will be `https://docs.tizen.org/dotnet/guide/LINKBB'.

So...
When we review PRs on tizen-docs repo, we strongly recommended, to check all linked paths in the file.
The person who is changed the file path has to find out all links to the changed file, and update the file path in all files.

Redirection makes be hard to find out all links. For example, writes will find out only LINKAA.md and then change LINKBB.md.
What happens to LINKA.md link? It will be a broken link.
It's one of maintenance.

@piotrekgorny
Copy link
Contributor

@journey2w
We did our best so all local links targeted changed locations work correct (some of them were also fixed in the review performed by @nawab-samsung and @annie-samsung). I think that all local links (inside docs.tizen.org) should be ok.

We prepared a list of changed locations (creating redirections) to handle broken links in external sevices (eg. StackOverflow).

@piotrekgorny
Copy link
Contributor

We could also consider adding some comments (markdown metadata, markdown comments or html comments) to the files which are target of redirection so the author know that if he move this file - the redirect definition should be also updated.

@annie-samsung
Copy link
Contributor

@piotrekgorny, as @journey2w mentioned file rename can lead to broken links if we do not check and resolve all the dependencies. For PR 1387, I think at least for renamed files I did a grep to check if the old file name was referred anywhere else. However, I am not sure if I performed this action for every single file.

@piotrekgorny
Copy link
Contributor

@annie-samsung
We also performed a search to find broken links to pages which we moved but we found nothing.

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

No branches or pull requests

4 participants