parallaxsecond / parsec-book

Parsec documentation
https://parallaxsecond.github.io/parsec-book
Apache License 2.0
12 stars 17 forks source link

Update quickstart info and release version #158

Closed gowthamsk-arm closed 1 year ago

gowthamsk-arm commented 1 year ago

This commit contains the following changes:

Signed-off-by: Gowtham Suresh Kumar gowtham.sureshkumar@arm.com

gowthamsk-arm commented 1 year ago

Within the parsec-book repo, I've made sure there are no references to the deleted pages and I can't recollect the community discussion related to this. I'm happy to stick with the previous strategy.

As a reader, those pages looked odd while reviewing the book so that prompted me to make this change.

adamjohnstonarm commented 1 year ago

Are we confident that deleting these files will not result in broken links? Our previous strategy was to maintain the older Quickstart files with a "content has moved" message, just in case there were any specific links to those pages. The Docker one was never populated to begin with, but arguably it should be treated in a uniform manner (with a similar "content has moved" message).

If I understood the original changes, we were keeping the pages but removing the links to them from the ToC. That should be ok.

gowthamsk-arm commented 1 year ago

In the first version of my changes I was deleting the pages as well.

adamjohnstonarm commented 1 year ago

In the first version of my changes I was deleting the pages as well.

I see that now. Unless SUMMARY.md is automatically generated or it prunes un-referenced content, it should still be possible to leave the stub/redirect pages intact, but also remove the links from the Table of Contents. The Docker stub/redirect should also link to installation_options.md#option-3-use-a-quickstart-docker-image

gowthamsk-arm commented 1 year ago

I see that now. Unless SUMMARY.md is automatically generated or it prunes un-referenced content, it should still be possible to leave the stub/redirect pages intact, but also remove the links from the Table of Contents.

https://rust-lang.github.io/mdBook/cli/build.html If a file is not mentioned in Summary.md, it won't be considered for the build.

Will update the docker link