Skip to content

Split up the about page #924

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

Merged
merged 19 commits into from
Aug 6, 2020
Merged

Split up the about page #924

merged 19 commits into from
Aug 6, 2020

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Jul 31, 2020

User visible changes

  • Split /about into several pages so it's not as long
  • Link to /about/builds if a build fails
  • Don't suggest opening an issue if the rust compiler isn't recent enough. This is no longer a major issue since we automatically update on each build.
  • Add 'Detecting docs.rs from {build.rs,#[cfg]}' sections
  • Add 'Missing dependencies' section. Previously this was only linked when opening a new issue.
  • Link to the queue from /about and /about/builds
  • Note that crates are never allowed internet access, with no exceptions

Internal changes

  • Don't rerun the build script whenever a template changes
  • Allow dynamically choosing a template in impl_webpage

Addresses #923, #888.

@Kixiron

This comment has been minimized.

@jyn514

This comment has been minimized.

@jyn514 jyn514 added A-frontend Area: Web frontend C-enhancement Category: This is a new feature S-waiting-on-author Status: This PR is incomplete or needs to address review comments labels Jul 31, 2020
@jyn514

This comment has been minimized.

@Nemo157
Copy link
Member

Nemo157 commented Aug 1, 2020

I love the centered TOML, we should keep that in the final styling 😁

One suggestion: put a breadcrumb back to the main "About" page in the header of each page:

About | Badges

@jyn514
Copy link
Member Author

jyn514 commented Aug 1, 2020

Updated!

image
image
image
image
image

@jyn514
Copy link
Member Author

jyn514 commented Aug 1, 2020

@jyn514 jyn514 changed the title [WIP] Split up about page Split up about page Aug 1, 2020
@jyn514 jyn514 added S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed and removed S-waiting-on-author Status: This PR is incomplete or needs to address review comments labels Aug 1, 2020
@jyn514 jyn514 changed the title Split up about page Split up the about page Aug 1, 2020
Copy link
Member

@Shnatsel Shnatsel left a comment

Choose a reason for hiding this comment

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

"How you can configure a build" is something I'd click if I was having trouble with my package building. Perhaps make it link to builds page?

Other than that LGTM. Thanks!

@jyn514
Copy link
Member Author

jyn514 commented Aug 1, 2020

'How you can configure a build' is a different section - it's about [package.metadata.docs.rs] in Cargo.toml, while 'Builds' is more of an overview of how builds work. It's a good idea to link there from a failed build though, I'll do that.

@jyn514
Copy link
Member Author

jyn514 commented Aug 1, 2020

I also changed the header bar so /about is easier to find.

Before:
about

After: image

@jyn514
Copy link
Member Author

jyn514 commented Aug 1, 2020

I tried adding icons as well but it didn't come out too well. Not sure why icons are so close to the text, and also some of the tabs it was hard to think of an image that matched. image

@jyn514
Copy link
Member Author

jyn514 commented Aug 1, 2020

Ooh, fa-road looks pretty nice :)

image

@jyn514
Copy link
Member Author

jyn514 commented Aug 4, 2020

This is ready for re-review :)

Copy link
Member

@Kixiron Kixiron left a comment

Choose a reason for hiding this comment

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

Looks good after nits, thanks!

@jyn514 jyn514 added S-waiting-on-deploy This PR is ready to be merged, but is waiting for an admin to have time to deploy it and removed S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed labels Aug 5, 2020
@jyn514 jyn514 merged commit 5026d6e into rust-lang:master Aug 6, 2020
@jyn514 jyn514 deleted the build-info branch August 6, 2020 17:06
@jyn514 jyn514 removed the S-waiting-on-deploy This PR is ready to be merged, but is waiting for an admin to have time to deploy it label Sep 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-frontend Area: Web frontend C-enhancement Category: This is a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants