New documentation site - request for help

philwareham · 2017-01-05 15:43:02

Hi Textpattern folks. You are probably aware that there is a new official Textpattern documentation site in development.

I really need some group help in tidying up the various doc pages there (I’ve done a lot already) – this will speed up completing this site so I can move onto the most important one – the new Textpattern homepage (.com) site.

Basically, I need a few people to go through the FAQ docs and change them to Markdown (Kramdown) formatting. I’ve done some of those as a starter so can give examples. The other sections needing major cleanup are ‘administration’ and ‘development’ – again I’ve done a few docs in those sections already so I just need a few extra pairs of hands to work through what’s left.

Let me know if you can help, and we can get started.

Bloke · 2017-01-05 15:58:51

I’m in. Sorry for not doing any over Christmas.

Regarding things like the diagnostics panel (github.com/textpattern/textpattern.github.io/blob/master/administration/diagnostics-panel.md#pre-flight-checks), what should we do about things like this:

All checks passed! {: .alert-block .success}

Presumably that showed the icon in the old docs? Or applied some CSS? What’s the equivalent Kramdown? Any examples?

On a related note, how do we link to images here now? Are such assets going to go in the /img directory? Any examples in other docs I can use as a template here too?

philwareham · 2017-01-05 16:05:18

Bloke wrote #303492:

All checks passed! {: .alert-block .success}

That page is actually done, and the syntax you mention is Kramdown code to put some classnames on the paragraph. See rendered doc here.

If it makes it easier, I can list which pages still need cleanup in an issue on GitHub – they can then be ticked off as people do them.

Regarding images, I’ve only put one in so far as a test, see example here

Bloke · 2017-01-05 16:10:43

philwareham wrote #303493:

That page is actually done, and the syntax you mention is Kramdown code to put some classnames on the paragraph.

My bad, you’re right. Last week, that page wasn’t complete. Nice one.

I can list which pages still need cleanup in an issue on GitHub – they can then be ticked off as people do them.

That’s a great idea actually. If it’s not too much work.

Regarding images [snip]

Sweet. Regular <img> tag it is. Thanks.

philwareham · 2017-01-05 16:14:13

Bloke wrote #303494:

That’s a great idea actually. If it’s not too much work.

Sure, I’ll create some issues. Although the FAQ section needs pretty much every FAQ tidied (but they are indivualy quote small chunks of text so it’s not as bad as it sounds given some extra help from people).

Once the FAQ section is done I can scrap those out of the .com site entirely and 301 redirect. Stops link rot.

Sweet. Regular <img> tag it is. Thanks.

Well, it’s an img tag with srcset so I can do high-res image versions, but yes.

Bloke · 2017-01-05 16:26:28

philwareham wrote #303495:

Although the FAQ section needs pretty much every FAQ tidied

Tidied-slash-scrapped? IIRC, we were planning on ditching a whole bunch of them, because they’re not exactly frequently asked, and most of the info is utter crap nowadays.

Any .com FAQs that we don’t translate to .io can just 301 to somewhere else as far as I care. FAQ landing page?

gaekwad · 2017-01-05 16:40:09

I’m in. Sorry I’ve not been around, December was tricky and horrible.

Please assign me stuff and I’ll gladly help.

philwareham · 2017-01-05 16:44:26

Bloke wrote #303496:

Tidied-slash-scrapped? IIRC, we were planning on ditching a whole bunch of them, because they’re not exactly frequently asked, and most of the info is utter crap nowadays.

Any .com FAQs that we don’t translate to .io can just 301 to somewhere else as far as I care. FAQ landing page?

The first task, if you want to do it, is it sift through all the FAQs here and delete from the repo any you feel are irrelevant now. The less there are, the less people have to tidy up.

michaelkpate · 2017-01-05 16:48:28

I apologize for volunteering back in August and not getting anything done but when I got some free time every page I looked at appeared to be updated.

I should have dug deeper.

philwareham · 2017-01-05 16:48:56

gaekwad wrote #303497:

Please assign me stuff and I’ll gladly help.

Thanks Pete, do you want to look at the Preferences administration panel doc and tidy it up – I made a start on it this morning and it’s probably one of the most useful docs there is.

It needs to follow the order within the Textpattern prefs panel, and be grouped by region. I made a start on the first region (Site preferences) and did the first 4 prefs. Just needs to be continued. The text for each preference is somewhere within the doc.

Maybe do a couple of pref entries then commit and let me know – I can then advise on if its as I intended.

I think you have commit rights to the repo – if not then holler back.

gaekwad · 2017-01-05 17:24:14

philwareham wrote #303500:

Thanks Pete, do you want to look at the Preferences administration panel doc and tidy it up – I made a start on it this morning and it’s probably one of the most useful docs there is.

Yep, will do. I have some time tonight (assuming I can fix the thing that someone broke in a client Magento…).

I think you have commit rights to the repo – if not then holler back.

I do. Will report back later.

colak · 2017-01-05 17:53:56

I found a minor issue and reported it here.

Textpattern CMS

Textpattern CMS support forum

#1 2017-01-05 15:43:02