docs icon indicating copy to clipboard operation
docs copied to clipboard

Import from wiki

Open kazk opened this issue 5 years ago • 13 comments

We have some documentation in our wiki. Import the pages that makes sense, restructuring as necessary.

See wiki/ for the files to work on.

kazk avatar Jul 07 '20 02:07 kazk

How are we supposed to do this? Copy/paste the text into a PR, somehow? (Yeah, outside of cw's katas, I'm absolutely "green"... x) )

edit: ok, I finally saw that the second link is actually a subdir of the present repo... x)

Blind4Basics avatar Jul 08 '20 10:07 Blind4Basics

We can start by creating issues for specific tasks. Then work from there. For example, I created #17 for Python test framework.

kazk avatar Jul 08 '20 18:07 kazk

I know we have old wiki available at /docs/wiki, but I believe it was transferred once and when original document will be updated, we need to synchronize it again if we want to migrate it? For example I updated "Troubleshooting" FAQ on original wiki, so I need to remember to migrate the latest version and one at /docs/wiki will be outdated, am I right?

hobovsky avatar Jul 13 '20 21:07 hobovsky

Yeah, edited pages are recorded on Zulip topic and that's probably the only one that changed.

kazk avatar Jul 13 '20 21:07 kazk

Is https://github.com/codewars/docs/blob/master/wiki/error-messages-submission-timed-out.md still relevant? I haven't seen such error in ages, and users also do not report it anymore. I guess the article was created when performance of CodeWars was much worse and today things are much better. Do we still need this page? Can we get rid of it if not?

hobovsky avatar Jul 13 '20 21:07 hobovsky

Yeah, let's get rid of it. I don't think it has happened since the runner was rewritten.

kazk avatar Jul 13 '20 21:07 kazk

Still to be transferred:

About

Reference

Tutorials

Snippets

Kata QA

I will create issues about them and prioritize them somehow.

hobovsky avatar Dec 30 '20 10:12 hobovsky

@kazk I have no good idea how to "migrate" the "Kata QA" part: lists of kata with some problems. Keep these as lists in docs, or maybe create dedicated Kata QA boards?

For others, I've created new project board which you (and anyone else) can use to prioritize the tasks so authors (probably me) could pick them for processing in some order.

hobovsky avatar Dec 30 '20 11:12 hobovsky

I wasn't planning to migrate that because those are temporary, and it's better to keep them editable by anyone to indicate progress. Maybe the docs can have a page about helping to maintain existing kata, and include a link to a wiki page listing the lists.

I had dumped all the pages I wanted to rewrite/import (except for the language pages) under /__tmp__ (originally named "wiki" as I wrote when I opened this issue).

kazk avatar Dec 30 '20 21:12 kazk

Oh and I thought that you just removed the wiki folder, I havent noticed it got renamed.

Do you have any priorities w.r.t. what should be migrated/written/added in the first order? If not, I will just continue picking topics from the list as I feel like.

hobovsky avatar Dec 30 '20 21:12 hobovsky

Sounds good to me. I can't think of any priorities at the moment.

kazk avatar Dec 30 '20 21:12 kazk

Can content of __tmp__ folder be modified, or you want to keep it unchanged as some kind of history or reference? Maybe removing migrated files or clearing migrated parts would help to keep track of what's already been processed?

hobovsky avatar Dec 30 '20 21:12 hobovsky

Maybe removing migrated files or clearing migrated parts would help to keep track of what's already been processed?

This was my intention. You can do whatever you want with them.

kazk avatar Dec 30 '20 21:12 kazk