Skip to content

Better fix code blocks in /about #1325

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

Closed
wants to merge 2 commits into from

Conversation

camelid
Copy link
Member

@camelid camelid commented Mar 21, 2021

This is a followup to #1315 to fix the extra blank line at the top and
to fix the indentation.

This fix is based on this suggestion: #1315 (comment)

This is a followup to rust-lang#1315 to fix the extra blank line at the top and
to fix the indentation.
@camelid camelid changed the title Better fix code blocks in /about/ Better fix code blocks in /about Mar 21, 2021
{% filter dedent(levels=4) -%}
<pre><code class="lang-rust">
if let Ok(_) = std::env::var("DOCS_RS") {
{% filter dedent(levels=3) -%}
Copy link
Member Author

Choose a reason for hiding this comment

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

Hopefully the removal of the newline after <pre><code> will interact nicely with this dedent level...

@jyn514
Copy link
Member

jyn514 commented Mar 21, 2021

Can you post a screenshot of what this looks like?

@camelid
Copy link
Member Author

camelid commented Mar 21, 2021

Can you post a screenshot of what this looks like?

Unfortunately I can't because I don't have a local docs.rs dev environment.

@jyn514
Copy link
Member

jyn514 commented Mar 21, 2021

You should be able to build the web server even if crate builds don't work. Try cargo run start-web-server.

@jyn514 jyn514 added A-frontend Area: Web frontend S-waiting-on-author Status: This PR is incomplete or needs to address review comments labels Mar 21, 2021
@camelid
Copy link
Member Author

camelid commented Mar 21, 2021

I'm getting errors like Error: configuration variable CRATESFYI_PREFIX is missing and Error: configuration variable CRATESFYI_DATABASE_URL is missing.

@jyn514
Copy link
Member

jyn514 commented Mar 21, 2021

Please read the README. You need to copy the .env.sample file to .env.

@camelid
Copy link
Member Author

camelid commented Mar 21, 2021

Please read the README. You need to copy the .env.sample file to .env.

I assumed that section of the README was irrelevant because it described using docker-compose and downloading a bunch of crate data.

@jyn514
Copy link
Member

jyn514 commented Mar 21, 2021

If you're not building crates, all parts of the readme are still relevant except the ones explicitly about building crates:

# Build a sample crate to make sure it works
# This also sets up the docs.rs build environment.
# This will take a while the first time but will be cached afterwards.
cargo run -- build crate regex 1.3.1
# Generate important files for the web navigation
cargo run -- build add-essential-files

Everything else is still accurate. If you like you could make a PR clarifying it :)

@jyn514
Copy link
Member

jyn514 commented Apr 14, 2021

@camelid are you still interested in working on this?

@jyn514 jyn514 closed this Apr 14, 2021
@jyn514 jyn514 reopened this Apr 14, 2021
@jyn514
Copy link
Member

jyn514 commented Apr 15, 2021

I tested and this works correctly:
image

Are you interested in doing the same for the metadata page?
image

@camelid
Copy link
Member Author

camelid commented Apr 16, 2021

@camelid are you still interested in working on this?

Yeah, sorry for the delay! I just haven't gotten around to setting up the dev environment.

I tested and this works correctly:

Thank you for testing it! I'm glad it works :)

Are you interested in doing the same for the metadata page?

I just pushed up a commit that should fix that (eea9807). Could you check if it works? Thanks :)

@jyn514
Copy link
Member

jyn514 commented Apr 17, 2021

Could you check if it works? Thanks :)

I'd prefer to help you get the development environment working - let me know if you run into trouble with that.

@jyn514
Copy link
Member

jyn514 commented Jun 21, 2021

@camelid are you still planning to work on this?

@jyn514
Copy link
Member

jyn514 commented Jun 24, 2021

Closing due to inactivity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-frontend Area: Web frontend S-waiting-on-author Status: This PR is incomplete or needs to address review comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants