Issue 13 fix guides page #19

gridcat · 2021-12-19T18:41:05Z

Retire standalone guide pages
Create tabs on guides pages
Adjust view and content (slightly) of each guide
Moved guides content into includes, so the guides page won't be so crowded

Fixes #13

Note: We need to improve the content of the guides. Since the solo crunching guide looks OK, the other two are definitely need some attention. While working on this issue I almost didn't touch the content itself as I can not consider myself as a tech writer (furthermore I ain't no native speaker) so I just removed non-related text from there. The guides on the original .us website for pool and staking-only aren't detailed enough and a little bit rather confusing, so perhaps some work needs to be done there as well to my opinion.
Hence I suggest to not rely on the content of this PR but rather have additional issues to adjust content.

barton2526

Why are you putting underscores at the front of guides? The html and markdown have no _ at the start

gridcat · 2021-12-19T20:12:55Z

Why are you putting underscores at the front of guides? The html and markdown have no _ at the start

The only reason is to keep thing consistent in the _includes folder.

gridcat · 2021-12-20T08:47:38Z

@barton2526 was it a question or suggestion to change? could you please be more specific?
as I can see all files within the _includes folder are prefixed with underscore.

barton2526 · 2021-12-20T09:02:26Z

I'm not familiar enough with the original rationale to say. Perhaps @RoboticMind knows

RoboticMind · 2021-12-20T12:54:46Z

Underscores tell Jeykll to not try to build that file or folder directly.

Every file or directory beginning with the following characters: ., _ , # or ~ in the source directory will not be included in the destination folder

https://jekyllrb.com/docs/structure/

Technically the files in the _include directory don't need to have and _ in front of them because the folder is already ignored. The files were like that before I started working with the gridcoin.us site and I've just kept it consistent with that. I would have no issue changing it to not have underscores in that folder as long as you change all the {%include _filename.extension %} to be {%include filename.extension %}, it would be fine.

gridcat · 2021-12-21T08:08:39Z

@RoboticMind I think it would be better to have separate issue for that as this is not related to this one. Plus it would be easier to test. wdyt?

gridcat · 2021-12-21T08:53:28Z

any other issues with this PR?

RoboticMind

With some of the more detailed guides being removed, the guides there look like they might need some changes

_includes/_guides/_solo_crunching.htm

RoboticMind · 2021-12-22T14:35:44Z

_includes/_guides/_solo_crunching.htm

+                          </li>
+                      </ul>
+                  </li>
+                  <li>Send a beacon.</li>


This needs a whole step like it had in the more detailed guides. Sending a beacon involves multiple steps

This step will require screenshots and a lot of text. This simplified stepper probably not a very good fit for it. It will look very cluttered. I think it deserves a separate page. What if we will have here a link instead to the individual page here instead?
I can refer to the .us website page temporarily (https://gridcoin.us/guides/earn-grc.htm) and have a ticket to craft the page later as a part of .world website. wdyt?

That would work for now

_includes/_guides/_solo_crunching.htm

RoboticMind · 2021-12-22T14:38:52Z

_includes/_guides/_solo_crunching.htm

+              </h3>
+          </header>
+          <div class="step-body">
+              <h4 class="h5">Check Your Projects</h4>


Might want to mention the GDPR requirements some projects have somewhere in here

Hm, good point. Also I think the GDPR should be mentioned on whitelist page also. Perhaps it worth to create an to extend the whitelist page.

I created the issue with a requirements to extend whitelist page with GDPR requirements.
Updates at this section is a part of that task.

Co-authored-by: RoboticMind <[email protected]>

…n-World-Site into issue-13-fix-guides-page

gridcat · 2022-01-18T12:30:07Z

@RoboticMind please have another look at this PR.

gridcat · 2022-01-18T12:31:36Z

And I think it is worth to deploy it despite the fact that some parts are missing. Those issues could be addressed as another PR. I believe this improvements worth to have deployed, it should be better anyway.

RoboticMind

I read over it again and noticed a few other issues with the wording/outdated information

_includes/_guides/_boinc_introduction.htm

_includes/_guides/_pool_crunching.htm

_includes/_guides/_solo_crunching.htm

_includes/_guides/_pool_crunching.htm

_includes/_guides/_staking_only.htm

_includes/_guides/_solo_crunching.htm

RoboticMind

Looks good. Can you squash some of these commits? Will merge after that

gridcat · 2022-01-18T19:30:15Z

I guess the proper way would be to Squash during the merge. I believe github should offer this choice. My attempt seems failed.

barton2526 · 2022-01-18T20:34:44Z

That option would result in one commit. I think Robotic meant to reduce 22 to a more manageable number, but still keep them modular (ie >1)

gridcat · 2022-01-24T20:20:32Z

I understand, so I tried before your message doing this in a regular way (rebase ~10, the mark as squash) but seems like because this branch is already on a remote I can not rewrite the history.
I may doing something wrong so I can use some help here.

barton2526 · 2022-01-24T21:00:28Z

You need to squash locally and then force push to gridcat:issue-13-fix-guides-page

Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_boinc_introduction.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_pool_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_staking_only.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_pool_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_boinc_introduction.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_pool_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_staking_only.htm Co-authored-by: RoboticMind <[email protected]> Update _includes/_guides/_solo_crunching.htm Co-authored-by: RoboticMind <[email protected]>

gridcat · 2022-01-24T21:13:46Z

@barton2526 thank you, --force did a trick!

gridcat · 2022-01-26T15:54:38Z

@RoboticMind can we have it merged now?

RoboticMind · 2022-01-27T02:43:13Z

Merged

gridcat added 7 commits December 15, 2021 20:49

style: use 4 spaces - fix old code

8b16068

feat: make tabs

9048f02

feat: adjust content of staking-only guide

19374ea

refactor: active css to the link itself

9e26261

fix: make staking-only guide reliable

2bff368

feat: make pool crunching guide reliable

33c7013

feat: switch tabs according to the hash in the url

4395776

barton2526 added the enhancement New feature or request label Dec 19, 2021

barton2526 reviewed Dec 19, 2021

View reviewed changes

barton2526 assigned gridcat Dec 19, 2021

RoboticMind requested changes Dec 22, 2021

View reviewed changes

Update _includes/_guides/_solo_crunching.htm

b9e9f91

Co-authored-by: RoboticMind <[email protected]>

gridcat mentioned this pull request Dec 23, 2021

Files include _includes directory don't need to prefixed with underscore. #26

Open

gridcat added 2 commits January 8, 2022 17:17

fix: address CR

ecd6cd7

Merge branch 'issue-13-fix-guides-page' of github.com:gridcat/Gridcoi…

3c49659

…n-World-Site into issue-13-fix-guides-page

gridcat mentioned this pull request Jan 18, 2022

Add GDPR requirements to the project whitelist page #27

Open

RoboticMind requested changes Jan 18, 2022

View reviewed changes

RoboticMind reviewed Jan 18, 2022

View reviewed changes

_includes/_guides/_solo_crunching.htm Outdated Show resolved Hide resolved

RoboticMind approved these changes Jan 18, 2022

View reviewed changes

gridcat force-pushed the issue-13-fix-guides-page branch from 8bf7cce to d03b300 Compare January 24, 2022 21:12

RoboticMind merged commit bf42233 into gridcoin-community:master Jan 27, 2022

gridcat deleted the issue-13-fix-guides-page branch January 28, 2022 10:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 13 fix guides page #19

Issue 13 fix guides page #19

gridcat commented Dec 19, 2021 •

edited

Loading

barton2526 left a comment

gridcat commented Dec 19, 2021

gridcat commented Dec 20, 2021

barton2526 commented Dec 20, 2021

RoboticMind commented Dec 20, 2021

gridcat commented Dec 21, 2021

gridcat commented Dec 21, 2021

RoboticMind left a comment

RoboticMind Dec 22, 2021

gridcat Dec 23, 2021

RoboticMind Dec 23, 2021

RoboticMind Dec 22, 2021

gridcat Dec 23, 2021

gridcat Jan 18, 2022

gridcat commented Jan 18, 2022

gridcat commented Jan 18, 2022

RoboticMind left a comment

RoboticMind left a comment

gridcat commented Jan 18, 2022

barton2526 commented Jan 18, 2022

gridcat commented Jan 24, 2022

barton2526 commented Jan 24, 2022

gridcat commented Jan 24, 2022

gridcat commented Jan 26, 2022

RoboticMind commented Jan 27, 2022

Issue 13 fix guides page #19

Issue 13 fix guides page #19

Conversation

gridcat commented Dec 19, 2021 • edited Loading

barton2526 left a comment

Choose a reason for hiding this comment

gridcat commented Dec 19, 2021

gridcat commented Dec 20, 2021

barton2526 commented Dec 20, 2021

RoboticMind commented Dec 20, 2021

gridcat commented Dec 21, 2021

gridcat commented Dec 21, 2021

RoboticMind left a comment

Choose a reason for hiding this comment

RoboticMind Dec 22, 2021

Choose a reason for hiding this comment

gridcat Dec 23, 2021

Choose a reason for hiding this comment

RoboticMind Dec 23, 2021

Choose a reason for hiding this comment

RoboticMind Dec 22, 2021

Choose a reason for hiding this comment

gridcat Dec 23, 2021

Choose a reason for hiding this comment

gridcat Jan 18, 2022

Choose a reason for hiding this comment

gridcat commented Jan 18, 2022

gridcat commented Jan 18, 2022

RoboticMind left a comment

Choose a reason for hiding this comment

RoboticMind left a comment

Choose a reason for hiding this comment

gridcat commented Jan 18, 2022

barton2526 commented Jan 18, 2022

gridcat commented Jan 24, 2022

barton2526 commented Jan 24, 2022

gridcat commented Jan 24, 2022

gridcat commented Jan 26, 2022

RoboticMind commented Jan 27, 2022

gridcat commented Dec 19, 2021 •

edited

Loading