ForumPostAssistant / FPA

The Forum Post Assistant (FPA) script has been developed to assist Joomla!® forum posters to be able to post relevant system, instance, PHP and troubleshooting information directly in to a pre-formatted forum post. This will save a few hours of posting back and forth, asking for, and explaining how to acquire useful information in order for other forum users to help troubleshoot a problem.
https://forumpostassistant.github.io/docs/
GNU General Public License v2.0
25 stars 15 forks source link

ForumPostAssistent / docs #90

Closed frostmakk closed 4 years ago

frostmakk commented 4 years ago

Upon release of rhytidectomy, docs should be updated. In the quick start guide at least this step will be outdated. image

The administrator guide is only half written. Any takers?

sozzled commented 4 years ago

At the same time as you wrote this, @frostmakk, I had the same thoughts, too.

RussW commented 4 years ago

My thoughts were to do a minor "framework rewrite to make it simpler and move away from using the standard "jekyll" and just making it html pages (there will be no dynamic options as we can't use PHP on Github pages, and moving away from jekyll removes embedding any Github dynmaic functions, but I don't see that as a big problem as at the moment I think the only dynamic thing is automatically pulling the latest versioning

frostmakk commented 4 years ago

As sozzled mentioned in the duplicate issue, most of the content in the documentation folder is obsolete, and can be trashed. There is however one thing I wold like to be carried over to the online docs. A step 8 with something like:

Now. We have mentioned it. Our hands are clean. 😎

mandville commented 4 years ago
* If the FPA has picked up a PHP error message, you may want to check if there is something in the message you want to mask. Edit directly in the post if needed, and preview again. Submit the post to the forum when satisfied.

suggest The PHP error message may contain confidential information, please review and edit as needed before posting.

RussW commented 4 years ago

I'm certainly happy with just removing the "Documentation/" folder, I was going to ask if still wanted the images anyway.

I will take on converting the jekyll docs site to straight html and updating, once we have released and potentially any currently unnoticed omissions/errors are reported.

And then if there is a desire for a PDF User Guide, it can be generated in-part from the docs site to reduce a little extra work and overhead, including adding new notes etc.

RussW commented 4 years ago

GNU GPL v2 NOT v3

sozzled commented 4 years ago

@RussW: I think I've done as you asked,

sozzled commented 4 years ago

My first PR! :flushed: :cold_sweat:

RussW commented 4 years ago

Can we close this to "Documentation Update Issue : https://github.com/ForumPostAssistant/docs/issues/6 ?

frostmakk commented 4 years ago

Yes. Looks like everything here has been taken care of. Closing.