Repository navigation
Discard the old book and migrate the book content to this new repo #94
Description
Is your feature request related to a problem? Please describe.
The maintainers and community only need one single source for docs. Two docs will make it confused.
Describe the solution you'd like.
For this issue, we have three things to do.
- Discard the old book, see an ongoing PR 1
[Docs] Discard the WasmEdge Book WasmEdge#2541. I have done most of the things. To avoid double work, please continue your work on this PR. - migrate the book content to this new repo since the 0.12.0 release, which needs to create a new PR on WasmEdge/doc
- How to deal with the links to old books? The links have been everywhere. How to make sure the links still work and can direct users to the right content.
Describe alternatives you've considered
No response
Additional context.
No response
Activity
alabulei1 commentedon Jun 7, 2023
@juntao Do you have other ideas?
alabulei1 commentedon Jun 7, 2023
@adithyaakrishna Please also take a look. This is part of GSoD.
juntao commentedon Jun 7, 2023
Yes. I think we should not delete any page from the old book. Instead, we should change the pages to say:
This doc has moved to here.
We should do this for every single page in the old book as we build out the new book.
adithyaakrishna commentedon Jun 7, 2023
Can we add like a admonition kinda thing? Similar to what we have in docusaurus?
For example, a caution note?
alabulei1 commentedon Jun 7, 2023
This is a good one. But I'm not sure if mdbook supports this.
adithyaakrishna commentedon Jun 7, 2023
@alabulei1 It is supported, I am very new to mdbooks and I am not sure where to install this plugin, but we have a preprocessor for the admonitions. Here's the link, https://crates.io/crates/mdbook-admonish
juntao commentedon Jun 7, 2023
I do not think we should spend time making MDBOOK look good -- we are moving AWAY from it after all. It is far more important to delete ALL content from MDBOOK and move to Docsauraus now.
The MDBOOK will just just serve as a redirect.
alabulei1 commentedon Jun 7, 2023
@adithyaakrishna according to the above comments. I think the first priority is to delete everything from MDBOOK because we must have one single source of truth. You can get started with my PR #WasmEdge2541. Can you estimate when you can make the PR ready to merge?
For the content doesn't be migrated, please open a PR on WasmEdge/docs repo. Thanks.
adithyaakrishna commentedon Jun 8, 2023
@juntao @alabulei1 Makes sense, I will proceed with the above PR. @alabulei1 I will clone that branch and checkout as a separate branch, then we can see how to proceed with other changes. To handle links to previous docs, we can set up redirection in MDBOOKS which can redirect us to the new docs
alabulei1 commentedon Jun 13, 2023
@adithyaakrishna I have made the WasmEdge/WasmEdge#2541 be merged. Please delete other docs from WasmEdge/WasmEdge repo and migrate content for WasmEdge/docs. As we discussed before, this is our first priority.
JYC0413 commentedon Aug 24, 2023
Discard the old book and migrate the book content to this new repo
#94
The central problem discussed in the issue is that having two separate documentation sources for the project is causing confusion among maintainers and the community. The proposed solution includes discarding the old book and migrating its content to the new repository, while also addressing the issue of outdated links. Alternative suggestions include adding admonitions or caution notes and using a preprocessor plugin for mdbook. The agreed-upon solution is to delete all content from the old book and migrate it to the new repository, with redirection set up to handle links to the previous docs.