Skip to content

Revamp the "Build" section. #252

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 43 commits into from

Conversation

johnnymatthews
Copy link
Contributor

@johnnymatthews johnnymatthews commented Aug 16, 2020

The Build section is a bit of a mess, and needs reorganizing. This PR will likely need tweaking to fit with @cwaring's layout and sidebar changes.

Closes #248

Tasks

  • Add all the networks to the build/networks page.
  • In build/getting-started explain how to set up a node once the reader has finished installing Lotus (there likely isn't much they have to do).
  • Add a simple ping your node command on the build/getting-started page to test the readers set up.
  • Include some common config suggestions for a dev node.
  • Fix sub-sub-sub sections in tutorials (5a xyz, etc)

@johnnymatthews johnnymatthews marked this pull request as draft August 16, 2020 14:39
@cwaring
Copy link
Contributor

cwaring commented Aug 17, 2020

Taking a quick look over this and there are a few issues I think we should solve before going this route.

  1. You've broken some of the content links by changing from relative paths, all internal content links in the documents must be ../folder/markdown.md instead of to /absolute/path/ because otherwise we can't automatically check them for 404s and it's not possible to navigate from GithHub.

  2. If we make the tutorials into a single pages we need to consider a couple of things. Goal tracking in analytics will be much harder as we don't know if a user has reached the final step and we only get a single "was this helpful" vote for the whole tutorial. We may need to discuss what our targets are with these tutorials in order to pick the right layout approach OR build a custom view for really long pages so we can improve the UX and trigger correct metrics.

  3. These sidebar changes will conflict once feat: documentation navigation refactor #239 has been merged so any changes there will need to manually ported across. Prepare for a lot of red lines 😅

@johnnymatthews
Copy link
Contributor Author

johnnymatthews commented Aug 17, 2020

... You've broken some of the content links by changing from relative paths ...

@cwaring No worries, I'll fix them now.

... If we make the tutorials into a single pages we need to consider a couple of things...

@cwaring if this is too hard to do right now then let's just scrap it. I found going through the tutorials in there current state confusing and convoluted, and I had to keep referring back to previous pages to understand what as going on. That problem is because of the general structure of these tutorials needs re-writing, but because we're short on time moving things into a single page was a quick fix. But again, if it's too hard to get the right analytics sorted, I'll just scrap it and we'll re-organize the tutorials down the line.

... These sidebar changes will conflict ...

@cwaring Yeahp, I'm aware. That's why this PR is still a draft. Waiting for that merge to go in so I can cherry pick the changes from here.

@cwaring
Copy link
Contributor

cwaring commented Aug 17, 2020

@johnnymatthews thanks! I would rather us work towards the best reading experience and if you think a single page for these types of tutorials works then let's to that and I can wire in any extras to fit later, for now I just wanted to throw it into the ring for consideration :)

@mishmosh
Copy link
Contributor

The networks.md page needs to stay outside of the Build section, since many different types of users (miners, builders, clients) all need to reference that info.

In general this is a MASSIVE PR that is hard to follow along with. Any chance this could be split into smaller changes — the refactor first, and then significant batches of content edits in their own PRs?

@johnnymatthews
Copy link
Contributor Author

@cwaring I'm confused. Do you want me to revert the examples section to how they were (separate pages) or leave my changes in here?

The networks.md page needs to stay outside of the Build section

@mishmosh yeah probably. Where do you reckon it should go? It could go into the new Install Filecoin section (pending PR review).

In general this is a MASSIVE PR that is hard to follow along with.

@mishmosh yeah sorry about that. I was told we needed to move fast and get stuff out the door before Space Race. I didn't expect this PR to face much review/discussion. If @cwaring would like to revert back to the examples section to how they were then I'll just close this PR, make a new one, and cherry pick in the small changes.

@cwaring
Copy link
Contributor

cwaring commented Aug 18, 2020

@cwaring I'm confused. Do you want me to revert the examples section to how they were (separate pages) or leave my changes in here?

Keep them as single pages if that improves the reading exp, I just wanted to note potential issues so we can track and fix in future updates. If we use this same pattern for other tutorials then that will be great.

@johnnymatthews johnnymatthews marked this pull request as ready for review August 20, 2020 17:32
@johnnymatthews johnnymatthews marked this pull request as draft August 20, 2020 17:38
@johnnymatthews johnnymatthews self-assigned this Aug 20, 2020
@johnnymatthews
Copy link
Contributor Author

johnnymatthews commented Aug 26, 2020

Closing this PR because it's become far too difficult to manage. I've created another, easier to follow, PR that contains a handful of the issues addressed here. #332.

I'm not deleting the branch just in case we need to come back here at some point soon.

@johnnymatthews johnnymatthews deleted the feat/revamping-build-section branch August 31, 2020 14:25
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.

Improve the Build section.
4 participants