FAQ

Why Does the Documentation not Provide a Title?

../_images/missing-title.png

Refer to Necessary Steps in order to fix this issue.

You must add the project title to your Settings.cfg :

[general]

# .................................................................................
# ...   (required) title (displayed in left sidebar (desktop) or top panel (mobile)
# .................................................................................

project     = title, e.g. extension name

# .................................................................................
# ...   (recommended) version, displayed next to title (desktop) and in <meta name="book-version"
# .................................................................................

release     = 2.0.0

Settings.cfg provides detail information.

How Do I Find My New Rendered Documentation?

There are several possibilities:

  1. Search for the extension on https://docs.typo3.org/Home/Extensions.html .
  2. Or, create URL manually, see URL Structure .
  3. Or, if it was just rerendered, the URL will be referenced from https://intercept.typo3.com/admin/docs/deployments . The column Branch contains the link.

Is it Possible to Highjack Extension Documentation?

How do you make sure only the author of the extension publishes the documentation?

Documentation rendering is restricted to one repository per package.

I.e. if someone triggers documentation rendering with a repository with vendor myVendor and package myPackage , then nobody else will be able to trigger documentation from a different repository with that exact vendor/package name combination. You could say this works on a first come first served basis. However, if someone with malicious intent registers a package first from a fake or wrong repository, we will have to correct this by hand. The original author should in that case notify us.

Is There a Way to Manually Trigger Docs Rendering Aside From a Git Repository Push?

Yes and no. Regular users do not have this option at the moment. However, as a member of the Documentation Team you can go to https://intercept.typo3.com and log in with your typo3.org account. Then in the menu you can navigate to Documentation > Deployments . At the top right hand side you will see a button Add Configuration . By clicking this button and going through the form, you can add a repository manually without the hook. Nevertheless we strongly recommend the usage of the webhook.

Is Documentation Independant of TER?

Yes.

The documentation and the extension at TER ( https://extensions.typo3.org ) are two separate, independent entities.

In theory you could have the documentation in GitHub (for example) and the extension (code) somewhere else (or not in Git at all). You just need to fire the webhook from GitHub/GitLab/Bitbucket to trigger the documentation rendering.

Can I use a README.rst (or README.md) instead?

GitHub (or Gitlab, bitbucket) etc. automatically render a README.rst (or .md) on the repository homepage.

For TYPO3 documentation I am required to have extra documentation in a Documentation folder. This means I have to maintain 2 documentations. Or not?

Answer: No. You have these 2 options:

  1. Use a README.rst (or .md) and a Documentation/Index.rst (for example). This is done in our official manuals. The README.rst is not used as documentation, it is used as an about the repo file . The README is mostly used to direct users who come via GitHub (or Gitlab, Bitbucket etc.) to the rendered documentation on docs.typo3.org
  2. Or, use README.rst (or .md) as main documentation ( Start File ) and put everything in the README.rst . The Documentation/Settings.cfg file must also exist, but that is all that needs to be in the Documentation directory.

Important

About using method 2) There are currently still 2 open issues , but this is already resolved in a “development” version.

Actually, you have more options, but we do not want to make things too complicated.

Which one should you choose? That is up to you.

We recommend: Use method 1) for extensive documentation with several chapters, use method 2) for minimal documentation which can be maintained in one file.

How do I Get an “Edit me on GitHub” Button

Why might you want an “Edit me on GitHub” button on the rendered pages of your extension documentation?

"Edit me on GitHub" button

“Edit me on GitHub” button

It makes it easier to contribute to the documentation!

How do you enable this?

Just add this to your Settings.cfg and customize it:

[html_theme_options]

# to get the "Edit me on Github Button"
github_branch = master
github_repository = TYPO3-Console/TYPO3-Console

If you used the sample extension and followed the steps in Start Extension Documentation From Example Manual , you should actually already have this.

Look at the typo3_console extension for a working example.

Further Questions?

Get in touch with us, if you have problems, would like to ask questions or make suggestions.

Our team page contains information about how to contact us.