1KC icon indicating copy to clipboard operation
1KC copied to clipboard

Support Page Article Improvements (polkadirk)

Open keeganquigley opened this issue 3 years ago • 22 comments

Hi @polkadirk thanks for your interest in the 1KC program, moving the conversation here!

Please submit any ideas you have as a comment in this issue and we can move forward from there!

  • Tasks

  • [x] (5/per) Choose 3 support page articles and improve or fix errors. Based on these deliveries, we will review and workout next steps.

  • To Do

  • [x] Define support article improvement tasks

keeganquigley avatar Apr 21 '22 16:04 keeganquigley

@polkadirk I'll continue the convo here (via Discord). Go ahead and choose an existing support article to improve and/or fix errors on. Use this Google sheet to do your work on! https://docs.google.com/document/d/152XFFT5-8kM5PFpHjZatGxNxH_nAR8UiLYe6oVMia8w/edit

emresurmeli avatar Apr 22 '22 20:04 emresurmeli

Hi @polkadirk, just curious as to whether you are still interested in submitting your task. No worries if you are still working on it, just give me an update here. It can just be one or two articles if you'd like, and then after it is approved we will create a new task for more articles. Let me know if you have any questions. Otherwise, we will close this issue after a few days of inactivity.

keeganquigley avatar May 04 '22 18:05 keeganquigley

Hey @keeganquigley apologies for the delay. Have had a backlog on work to catch up on after returning home from Europe. This task is currently at the top of my to do list. Il have it completed before Monday morning next week. Christian

polkadirk avatar May 05 '22 01:05 polkadirk

@keeganquigley @emresurmeli I have attached a google drive which contains suggested edits to 3 articles from the support page.

https://drive.google.com/drive/folders/19k7PFb9iVu5kh2ifJMRVQl4z-i5KEvop?usp=sharing

Overall - the grammar across the website (I reviewed about 10 articles) is very good. I only found a couple of cases of genuine errors (they are suggested as edits in the google docs). There is however a few common language uses that I would not recommend. For example:

  • the use of aren't, you'd, you'll. I would not recommend using these terms in formal writing like support guides.
  • Many sentences start with 'this' or similar phrases - this is generally avoided wherever possible. Generally a publication will have a 'style guide' for these kind of things.

The larger issues with the articles is that they seem to be unclear for their intended audience. For example: The 'where to buy DOT and KSM' seemingly would be intended for new users - the article however lacks information that would be needed for a genuine new user. I also feel that more content aimed at onboarding users next to 0 blockchain knowledge may be beneficial.

Hope this was helpful!

Christian

polkadirk avatar May 09 '22 05:05 polkadirk

Thanks for your submission @polkadirk I have just a few comments/notes. First, I liked your improvements on the second article! They definitely help to improve tone and clarity. However, I am not seeing what edits you made on the first and third articles. Can you "suggest" edits rather than edit directly? Follow these instructions to edit in "suggestion mode". We will be asking this for all submissions moving forward.

Regarding your other comments, they are very helpful. I agree we could remove contractions from articles. We also like your suggestion about creating a style guide, which I have started building to not only allow us to establish better guidelines, but also to help contributors understand the standards we already have in place. I should have this completed soon. For now, if you can revise your edits I will review them in order to move you along to the next stage. Thanks!

keeganquigley avatar May 13 '22 18:05 keeganquigley

Hey Keegan! Apologies for the slow response - I have been away for the week. The articles I link have already included suggested edits. Though you may be unable to see them because of your permissions. Can you provide me your email? Il give you the correct permissions. Il also attach the files below. Thats great about your progress with a style guide - I am currently in the process of creating one for OAK Network. Potentially we could collaborate? If you have any free time I would love to jump on a quick call with you. Where to store DOT_ Polkadot wallet options.docx How to participate in crowdloans.docx

polkadirk avatar May 23 '22 07:05 polkadirk

Thanks for your response @polkadirk no worries! I just requested edit access on the docs so hopefully that will do the trick. You should be able to see my email address in the request. And yes, would love to collaborate! I'm happy to jump on a call; if you can email me back with your time zone, let's find a good time to meet up. Thanks!

keeganquigley avatar May 24 '22 16:05 keeganquigley

Sure thing! I am in AEST timezone - if you have any availabilities your time around 5pm (EST) that would suit my calendar well but im pretty flexible. Do you have a calendly?

polkadirk avatar May 26 '22 04:05 polkadirk

@polkadirk I do! 5pm works for me, I just sent my Calendly link to your email. Thanks!

keeganquigley avatar May 26 '22 21:05 keeganquigley

Thanks again @polkadirk I am happy to accept your submissions. Changes have already been implemented and comments were left in the Google docs. I have added new tasks below. Feel free to submit more changes and we will review them.

  • [ ] (5/per article) Work to make the articles have a uniform look, using the official style guide as a reference. This can include rewording/rephrasing headers, sections, paragraphs, etc. with the goal of improving the overall style.

  • [ ] (5/per article) Fix errors (grammatical, spelling, remove contractions, etc).

keeganquigley avatar Jun 01 '22 15:06 keeganquigley

Thanks Keegan - I am in the US for consensus so am a little busy but will get to making some changes next weekend.

polkadirk avatar Jun 06 '22 16:06 polkadirk

@polkadirk Could you send us a Kusama(karura) address so we can send you the payout?

emresurmeli avatar Aug 03 '22 22:08 emresurmeli

Hey there!

You can use this KSM address.

'Fy3xsUAyfHJoEZeD6aWLtbXCWarLJiojTY76EYFfRNBjZeH'

Please let me know if there are any issues

polkadirk avatar Aug 04 '22 02:08 polkadirk

Just saw your eddit - do you want a Karura address instead of KSM?

Karura - 'rh1WpibHQXfjazReHrecJC55RScfQVvs6rtnLQ4SYw7RPra'

polkadirk avatar Aug 05 '22 09:08 polkadirk

Hey @emresurmeli hope you're doing well.

any updates on this? do you need any more info from me?

polkadirk avatar Aug 12 '22 05:08 polkadirk

@emresurmeli is on vacation - @DrW3RK can you take a look at this?

laboon avatar Aug 12 '22 07:08 laboon

Hey Bill!

Im in no rush - happy to wait for Emre to finish vacation.

Best wishes,

Christian Dirk OAK Network

On Fri, Aug 12, 2022 at 5:38 PM Bill Laboon @.***> wrote:

@emresurmeli https://github.com/emresurmeli is on vacation - @DrW3RK https://github.com/DrW3RK can you take a look at this?

— Reply to this email directly, view it on GitHub https://github.com/w3f/1KC/issues/10#issuecomment-1212822224, or unsubscribe https://github.com/notifications/unsubscribe-auth/AY2CTQIU37EPO6YEIJQ6TKTVYX5PVANCNFSM5T7ZXTTA . You are receiving this because you were mentioned.Message ID: @.***>

polkadirk avatar Aug 13 '22 03:08 polkadirk

Hi @polkadirk, thank you for your contribution and patience! The Karura address works great.

emresurmeli avatar Aug 30 '22 14:08 emresurmeli

Welcome back! @emresurmeli

if you make a payment can you please send me the extrinsic ID so I can confirm I have received the funds?

polkadirk avatar Aug 31 '22 04:08 polkadirk

Thanks @polkadirk did you still wish to continue with more articles or should we go ahead and close this issue once payment is received?

keeganquigley avatar Aug 31 '22 20:08 keeganquigley

Hey @keeganquigley - i have a little more free time at the moment so im happy to continue. Is there any specific articles that need reviewing or should i just pick any and send to you?

polkadirk avatar Aug 31 '22 23:08 polkadirk

Thanks @polkadirk, we are starting to release articles featuring the new staking dashboard if you want to look those over, otherwise feel free to pick any that you like!

keeganquigley avatar Sep 01 '22 15:09 keeganquigley

Closing for @Polkadirk, as he had some other things come up to take care of.

keeganquigley avatar Feb 21 '23 18:02 keeganquigley