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

[Docs] Adjust publication to remove outdated docs and redirect to the proper default landing page #12356

Open
2 tasks
agneszitte opened this issue May 18, 2023 · 5 comments
Assignees
Labels
area/website Categorizes an issue or PR as relevant to the platform.uno website kind/documentation project/documentation 📖 Categorizes an issue or PR as relevant to documentation

Comments

@agneszitte
Copy link
Contributor

agneszitte commented May 18, 2023

On which page?

What's wrong?

Having proper redirection on missing content in general.
Like having proper redirection from https://platform.uno/docs/articles/uno-check.html to https://platform.uno/docs/articles/external/uno.check/doc/using-uno-check.html
Uno-check docs pages content should be merged to only have one page with everything related to uno-check

Any feedback?

Note: the uno-check blog post redirect to the readme of the uno-check repo, and this readme redirect to using-uno-check.md

Related issues

@agneszitte agneszitte added triage/untriaged Indicates an issue requires triaging or verification difficulty/tbd Categorizes an issue for which the difficulty level needs to be defined. kind/documentation labels May 18, 2023
@jeromelaban jeromelaban changed the title [Docs] Uno-check docs pages content should be merged to only have one page with everything related to uno-check [Docs] Adjust publication to remove outdated docs and redirect to the proper default landing page May 18, 2023
@jeromelaban
Copy link
Member

The fix is not merging documents, it's having proper redirection on missing content (that document was replaced a long time ago, and is still being referenced by search engines).

@agneszitte agneszitte self-assigned this May 23, 2023
@agneszitte
Copy link
Contributor Author

agneszitte commented May 23, 2023

I will check if there is a way to handle the redirection using docfx or if we need another solution

@agneszitte
Copy link
Contributor Author

agneszitte commented Jun 6, 2023

Notes from @Youssef1313 :
"I came across this dotnet/docfx#8340 and thought it might be useful.

Also found this while looking in the same topic in the codebase:
https://github.com/dotnet/docfx/blob/f28165af43dde2ec072a79fa2479f475fcd947ad/src/Microsoft.DocAsCode.Build.Engine/XRefMaps/XRefMap.cs#L31-L33

Might be relevant, though not well documented. This page https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html briefly mention that xrefmap.yml can be deployed, but doesn't mention redirections. But from the code above, it looks like redirections should be a thing in xrefmap"

@jeromelaban
Copy link
Member

As this is a new feature, we'll need to create an initial diff of the docs based on what's currently published publicly on our docs, then introduce a diffing system to determine if a doc update removes a page from the last CI build.

@agneszitte agneszitte removed their assignment Aug 2, 2023
@MartinZikmund MartinZikmund added project/documentation 📖 Categorizes an issue or PR as relevant to documentation area/website Categorizes an issue or PR as relevant to the platform.uno website and removed triage/untriaged Indicates an issue requires triaging or verification difficulty/tbd Categorizes an issue for which the difficulty level needs to be defined. labels Oct 25, 2023
@agneszitte agneszitte self-assigned this Jul 23, 2024
@agneszitte agneszitte linked a pull request Aug 1, 2024 that will close this issue
6 tasks
@agneszitte agneszitte removed a link to a pull request Aug 1, 2024
6 tasks
@morning4coffe-dev
Copy link
Member

morning4coffe-dev commented Sep 3, 2024

Cached pages on Google from internal Search epic:

image

image
-> https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Tutorials/Navigation/HowTo-NavigateInCode.html

image
previously features/windows-devices-sensors.md

image
missing toc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/website Categorizes an issue or PR as relevant to the platform.uno website kind/documentation project/documentation 📖 Categorizes an issue or PR as relevant to documentation
Projects
None yet
Development

No branches or pull requests

4 participants