textpattern.github.io icon indicating copy to clipboard operation
textpattern.github.io copied to clipboard

page: Post-install and upgrade routines

Open Bloke opened this issue 5 years ago • 4 comments

Absolute URL of front-end page

https://docs.textpattern.com/installation/post-install-and-upgrade-routines

The question/problem

Can we ditch this? Most, if not all, of the info is contained in the installation guide so maybe we just cherry-pick some phrases from it and cull this?

Bloke avatar Dec 06 '19 22:12 Bloke

Can we ditch this?

In a manner of speaking, yes, but I had envisioned it being the base for writing the new 'Configuration essentials' doc under 'Setup and Configuration' https://docs.textpattern.com/index2

Better to start with a page having something to re-use than a blank page. This would fold in languages, diagnostics, and all the essential preferences; knocking out many panel pages at once.

Btw, the full install instructions should not include any post- login setup material. I haven't looked at it yet, but just saying here as I think of it. It should end at first administrator login. Install task completed. The 'Configuration essentials' doc would then pick up at that point, and end where a person might be ready to think about changing site structure or working on a theme. So at the end of each doc are one or two logical links for continuing on with the new user journey, if that makes sense.

Not every user doc will be a linked journey like that, but these initial ones for index2 feasibly would be, until we get the old administration stuff entirely recycled and accounted for. After that, future docs probably reflect a single, specific subject/task and more or less stand on their own. Maybe there are concepts in the body matter that warrant cross-linking with other docs pages, whatever, but that's just if it happens to be that way, not the main objective for specific topic articles.

wion avatar Dec 08 '19 17:12 wion

Okay, just looked at the install doc. I forgot we're folding in the upgrading perspective too. That's fine. Looks good. We can still shape a 'Site configuration essentials' doc, though, as a unique doc. The goal here is more to recycle out all the admin panel pages than to worry too much about a linked user journey, in fact. ;)

wion avatar Dec 08 '19 17:12 wion

The only reason I folded in quick and detailed installation with upgrading in one doc, was because there was some commonality - especially with the files table that I moved to the bottom and made it universally applicable to either installation or upgrade.

If we need to split it out, then that's cool.

Bloke avatar Dec 08 '19 21:12 Bloke

Let's hold off on this for now. It will be more clear later what to do when other stuff has been combed and rewritten.

wion avatar Dec 09 '19 23:12 wion