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.

Sign up for GitHub

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

Jump to bottom

[TASK] Align with new TYPO3 documentation standards #9

Merged
merged 5 commits into from
Apr 21, 2022
Merged

[TASK] Align with new TYPO3 documentation standards #9

merged 5 commits into from
Apr 21, 2022

Conversation

alexander-nitsche
Copy link
Contributor

@alexander-nitsche
[TASK] Align with new TYPO3 documentation standards
868f056 
- align README.md
- add .editorconfig, Settings.cfg, Index.rst, Includes.rst.txt

See https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html for further details.
@alexander-nitsche
Copy link
Contributor Author

What is missing:
(1) Registering this documentation for rendering and publishing at docs.typo3.org with the webhook.
(2) Remove the documentation URL https://github.com/FriendsOfTYPO3/legacy-collections from the "External manual" field of the TER extension page configuration at https://extensions.typo3.org as the documentation at docs.typo3.org is detected automatically and a specific URL is error-prone.

@alexander-nitsche
Copy link
Contributor Author

How it looks:
Screen Shot 2022-04-04 at 11 32 20

@alexander-nitsche
[DOCS] Ignore the generated documentation folder
c64af7f
@alexander-nitsche
[DOCS] Pose with total and monthly download rate
484b355 
Each TYPO3 extension should show

- current release version
- total download rate
- monthly download rate
- supported and linked TYPO3 LTS version(s)

in badges.
@alexander-nitsche
[TASK] Add TER + documentation + repository to composer.json
35ba470 
Add the common extension destinations to composer.json. Packagist
displays them in a prominent place.
@alexander-nitsche
Copy link
Contributor Author

Added two new commits regarding badges in README and additional sources (TER, repository and docs.typo3.org) in composer.json.

Relates: TYPO3-Documentation/T3DocTeam#185

ohader
ohader requested changes Apr 20, 2022
View reviewed changes
Copy link
Contributor

@ohader ohader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid pointing to Benni here, refer to the issue tracker instead...

Documentation/Index.rst Outdated Show resolved Hide resolved
@ohader ohader merged commit e4c52ff into FriendsOfTYPO3:main Apr 21, 2022
@ohader
Copy link
Contributor

ohader commented Apr 21, 2022

TER foo done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ohader ohader ohader approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@alexander-nitsche @ohader