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

Amend Data Preparation guide #136

Merged
merged 18 commits into from
Jan 23, 2021
Merged

Amend Data Preparation guide #136

merged 18 commits into from
Jan 23, 2021

Conversation

neomatrix369
Copy link
Collaborator

@neomatrix369 neomatrix369 commented Oct 12, 2020

Adding Visualization sub-topic to Data preparation guide. Changes to create placeholders for links and contents to come across the other guides.

The overall structure and/or the content may change as new content gets closer to finalisation. But this is an evolving topic, so it's going to be continuously amended even after we merge the first finalised version.

@neomatrix369 neomatrix369 added enhancement New feature or request Hacktoberfest Related to the Hactoberfest (https://hacktoberfest.digitalocean.com/) guide labels Oct 12, 2020
@neomatrix369 neomatrix369 self-assigned this Oct 12, 2020
@neomatrix369 neomatrix369 marked this pull request as draft October 12, 2020 20:03
…create placeholders for links and contents to come across the other guides
@neomatrix369 neomatrix369 changed the title [Draft] Amend Data preparation guide [Draft] Amend Data Preparation guide Oct 12, 2020
@neomatrix369 neomatrix369 marked this pull request as ready for review November 11, 2020 20:52
@neomatrix369
Copy link
Collaborator Author

@clone95 let's start discussing the contents of this guide I have done lots of reorg and also added my own ideas to it. Although I keep thinking there are still small things I might have missed but together we can fill these missing parts.

@neomatrix369 neomatrix369 changed the title [Draft] Amend Data Preparation guide Amend Data Preparation guide Nov 11, 2020
@neomatrix369
Copy link
Collaborator Author

@neomatrix369
Copy link
Collaborator Author

@clone95 please invite anyone else to review this PR if you feel the need

Copy link
Collaborator

@clone95 clone95 left a comment

Choose a reason for hiding this comment

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

Very good job! 💯

I list here some of the more general comments, but it's mostly a braindump for me. Soon I will build a very small "editorial" guide for contributing, with both stylistic and formatting guidelines ( #141 ). So these comments are direct most to the old "me" when I was writing the old versione of the guide 1 year ago :

  • can't find some sections (like lowercaseUppercase..) in the final draft
  • the web app shows the subtitle (in the contextual menu on the left) only if ## or # is used. with more or equal than 3#### it doesn't shows it

Formatting

  • always use Virgilio as a third person, never 1st person ("I colleted for you..." --> "Virgilio collected for you...")
  • very minor stylist corrections like "s" and "z"
  • the formatting can be improved, using bold, italic, and splitting sentences
  • avoid long periods
  • avoid sentences with more than 1 or 2 dependant sentences. If it cannot be done, re-think the design of the sentence
  • split groups of more than 3-4 lines of text

@clone95 clone95 linked an issue Nov 29, 2020 that may be closed by this pull request
@neomatrix369
Copy link
Collaborator Author

neomatrix369 commented Dec 1, 2020

@clone95 I have finished this iteration of review, can you pls re-read the changes and my comments and come back with some suggestions and resolutions so we can wind up this guide for now

Let me know if I have missed anything and if it's within the guidelines you mentioned here.

@neomatrix369
Copy link
Collaborator Author

@clone95 Any more updates for this one before it can be merged?

@clone95
Copy link
Collaborator

clone95 commented Jan 23, 2021

Nice Mani! I think we are close to ready. I will push a couple of formatting fixes, then I will merge the PR

@clone95 clone95 merged commit b7030d6 into dev Jan 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request guide Hacktoberfest Related to the Hactoberfest (https://hacktoberfest.digitalocean.com/)
Projects
Purgatorio
  
Awaiting triage
Development

Successfully merging this pull request may close these issues.

None yet

2 participants