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

Update quickstart info and release version #158

Merged
merged 4 commits into from
Apr 5, 2023

Conversation

gowthamsk-arm
Copy link
Contributor

This commit contains the following changes:

  • The quickstart pages just have links to the installation guide. These are removed and installation page is renamed.
  • References to 1.1.0 release is changed to 1.2.0

Signed-off-by: Gowtham Suresh Kumar [email protected]

Copy link

@adamjohnstonarm adamjohnstonarm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but unable to verify instructions right now as hitting Ubuntu rate limit when building quickstart package

Copy link

@anta5010 anta5010 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@paulhowardarm paulhowardarm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

There might have been a community discussion where we talked about removing those files, but my memory is hazy. Did we conclude that removing them was the right thing to do? If so, then that's fine.

@gowthamsk-arm
Copy link
Contributor Author

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.

Signed-off-by: Gowtham Suresh Kumar <[email protected]>
The "cd" command changes the directory to "quickstart" so
these commands are updated.

Signed-off-by: Gowtham Suresh Kumar <[email protected]>
Signed-off-by: Gowtham Suresh Kumar <[email protected]>
@adamjohnstonarm
Copy link

adamjohnstonarm commented Apr 5, 2023

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
Copy link
Contributor Author

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

@adamjohnstonarm
Copy link

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
Copy link
Contributor Author

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

Signed-off-by: Gowtham Suresh Kumar <[email protected]>
Copy link

@adamjohnstonarm adamjohnstonarm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gowthamsk-arm gowthamsk-arm merged commit 2bc196c into parallaxsecond:main Apr 5, 2023
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

Successfully merging this pull request may close these issues.

4 participants