search

textpattern / textpattern.github.io

Textpattern CMS user documentation.
https://docs.textpattern.com
GNU General Public License v2.0
15 stars 17 forks source link

proposed: Content types: core and custom #151

Open wion opened 4 years ago

wion commented 4 years ago

back: https://github.com/textpattern/textpattern.github.io/blob/master/build/content-types.md front: https://docs.textpattern.com/build/content-types

Situation/Scenario for proposal

A single doc that discusses core content types, custom content types (per forthcoming functionality), and designing page/form architectures with these kinds of content needs in mind.

Value

This doc enables removing all the content panel pages, and should serve as a segue to building site structures doc.

Resources to consider for draft

Add information text and link

wion commented 3 years ago

Good show on the draft, @Bloke . I've been adrift so any progress is good progress.

I did not have the time today I thought I would but through this issue and by witness of Odin, I will read and comment as I can.

wion commented 3 years ago

Btw, let's wait on the index2 switch until we can at least set up redirects when needed, then we might avoid the 'I can't find' and 'this link is broken' types of responses.

Bloke commented 3 years ago

Oki doke. Whenever you have time, thank you.

And yeah, we can swap the index over at any time. The 'Textpattern basics' article is littered with links to panel docs, all of which will disappear off the navigation when we switch. And the tags also have a load of them. I might be able to rid us of those using some multi-file edit-fu in Sublime Text so the tags aren't so onerous to hack out.

I don't see much of use in the Textpattern Basics tutorial, but if a relative newbie (yesterday) says it's good as a refresher then maybe it does have some intrinsic value? Do we (or could we) have a space for tutorials in the new structure or are we going to migrate this type of content to Txp Tips or something where it's better in context?

wion commented 3 years ago

I don't see much of use in the Textpattern Basics tutorial, but if a relative newbie (yesterday) says it's good as a refresher then maybe it does have some intrinsic value?

For that article in particular... Why not make it article ID 2 in a default install? I think ID 1 is a similar concept. Two articles won't matter much. Then a user has it directly in context, and if not needed, can overwrite it with their own content.

Do we (or could we) have a space for tutorials in the new structure or are we going to migrate this type of content to Txp Tips or something where it's better in context?

IMO, tutorials are no different than FAQs; they are a genre of information that can just as easily be written into regular documentation. If I buy a computer, or new application, in-app docs are not written like faqs or tutorials, it's just documentation written with a consistent style and tone, well indexed, etc.

Tutorials, or whatever are best in Tips, or at people's blogs. On the Txp blog. Or in the mag. heh.

2 cents.

Bloke commented 3 years ago

I'm fine with not having tutorials in docs. Tips makes way more sense. Let's stick to that.

As for the Txp Basics, I dunno. We could add a second article. Or amalgamate it as article number 1, since we're likely gonna rewrite that anyway (there's a discussion about it somewhere). cf. https://github.com/textpattern/textpattern/issues/1599 too.

When we switch to index2, we can leave it to rot in the 'possibly recycle' bin and see.

wion commented 3 years ago

Another thought, whether the basic tute or otherwise... Figure out where a handful of well-written and maintained starter articles/resources are located and add them as links in a link category. I know there are some default links already that plug Txp sites, but maybe something more specific/valuable to the first-time user would be warranted.

So these could be at Txp Tips, in docs, at someone's blog, a video, whatever.

Bloke commented 3 years ago

Hey, that's not a bad idea. They'll then show up on the default site too in the sidebar. That has serious merit! Nice one.

wion commented 3 years ago

And if you announce that to the community, to game it, like 'Hey, write, shoot, or share your favourite new-user tute/resource and we'll hook up for the world to see in default Txp. Fame awaits!' Then maybe people will be inspired to write something. Who knows.

Bloke commented 3 years ago

I like the cut of your jib! I'll give it some thought and draft a post.