Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup overview tables #13

Closed
sypets opened this issue Feb 17, 2018 · 2 comments
Closed

Cleanup overview tables #13

sypets opened this issue Feb 17, 2018 · 2 comments

Comments

@sypets
Copy link
Contributor

sypets commented Feb 17, 2018

Subitle: Make TYPO3 docs landing pages look less like Work in Progress

This manual and especially the pages "Guides and Tutorials" and "References" are very prominent and important. They might be the first place someone looks who is new to TYPO3. For TYPO3 marketing purposes and in the intention of providing the best guidance, especially for new users, I think it is very important to clean up this page and make it look less like work-in-progress. I realize, there is still a lot of work to do, not every manual is in a final state and there are far less people working on things than are needed, but this page does not necessarily have to reflect that.

I think we should try to come up with pragmatic solutions for fixing this asap.

Proposal

  • Remove outdated manuals and WIP manuals (or better remove WIP tag if no longer applicable) from this list. If the WIP manual is the only thing we have, so be it. Strip it down to the basics and do the WIP work in a different place.
  • remove comment "The Extbase book" because it is redundant
  • remove or replace comment "Very unsufficient, but better than nothing." because it looks bad and is not helpful
  • If manuals are really hopelessly outdated and considered harmful, remove them entirely from this list. Maybe even remove them entirely
  • Possilby create another lists for old, deprecated and wip manuals.

Example:

For example, currently we have:

extbasefluid

People wanting to learn will be confused, ok there are 2 manuals. Why? One is "better than nothing", where should I start? And get a bad first impression of TYPO3 docs. What??? Why don't they maintain their documentation?

This could look like this:

  • change "Very unsufficient, but better than nothing." to a more descriptive phrase, e.g. "outdated", remove the book entirely from this list (if it is really so outdated) and move it to the old / deprecated / wip list
  • remove comment "The extbase book", because the title already says it all
@sypets
Copy link
Contributor Author

sypets commented Feb 17, 2018

See also #14

@sypets
Copy link
Contributor Author

sypets commented Jul 1, 2018

This has been partly handled by some edits that add more information to the Comment / Description column.

Also, the marker based tutorial has been replaced in the newer branches.

Currently, 2 more PR are pending:

@sypets sypets closed this as completed Jul 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant