[DOCS] Align README.md with other extensions #3218
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reduce README.md to an abstract and links to important pages that cover the user's next steps, especially the full documentation and TER page for installation, but also add-ons and the paid services. The details of the contribution are already in CONTRIBUTION.md and in the full documentation - and obvious if you look at the git history. The contact details should be moved to the full documentation. Keep outgoing links to a minimum to not distract the user.
|
hi dkd, hi guys, i just came across your extension documentation while having a look at intercept. this pr is to align with similar documentations, that want to improve the guiding of the user. it should provide him or her with all required information. furthermore i elaborated the abstract text a bit. |
|
One final question: Is the extension really still "alpha"? |
Nope, it is RC1, the alpha state is long gone |
Ok, it's just what's displayed on https://extensions.typo3.org/extension/solr. |
Each TYPO3 extension should show - current release version - total download rate - monthly download rate - supported and linked TYPO3 LTS version(s) in badges and put them to the front and the test status to the back.
Add the common extension destinations to composer.json. Packagist displays them in a prominent place.
|
Added two new commits regarding badges in README and additional sources (docs.typo3.org) in composer.json. Relates: TYPO3-Documentation/T3DocTeam#185 |
dkd-kaehm
approved these changes
Apr 14, 2022
There was a problem hiding this comment.
@alexander-nitsche Thanks for this improvement and moving to TYPO3 standards.
The change LGTM, but @dkd-friedrich and @dkd-dobberkau
should approve the PR as well.
dkd-kaehm
added a commit
that referenced
this pull request
Apr 19, 2022
Reduce README.md to an abstract and links to important pages that cover the user's next steps, especially the full documentation and TER page for installation, but also add-ons and the paid services. The details of the contribution are already in CONTRIBUTION.md and in the full documentation - and obvious if you look at the git history. The contact details should be moved to the full documentation. Keep outgoing links to a minimum to not distract the user. Each TYPO3 extension should show - current release version - total download rate - monthly download rate - supported and linked TYPO3 LTS version(s) in badges and put them to the front and the test status to the back. Add the common extension destinations to composer.json. Packagist displays them in a prominent place.
dkd-kaehm
added a commit
that referenced
this pull request
Apr 19, 2022
Reduce README.md to an abstract and links to important pages that cover the user's next steps, especially the full documentation and TER page for installation, but also add-ons and the paid services. The details of the contribution are already in CONTRIBUTION.md and in the full documentation - and obvious if you look at the git history. The contact details should be moved to the full documentation. Keep outgoing links to a minimum to not distract the user. Each TYPO3 extension should show - current release version - total download rate - monthly download rate - supported and linked TYPO3 LTS version(s) in badges and put them to the front and the test status to the back. Add the common extension destinations to composer.json. Packagist displays them in a prominent place.
dkd-friedrich
added a commit
to dkd-friedrich/ext-solr
that referenced
this pull request
Apr 22, 2022
Second release candidate of 11.5.0 for TYPO3 11 LTS #standwithukraine #nowar ## Huge improvements: * TYPO3 11 LTS compatibility * Improved data update handling ## Improvements and fixes since RC 1 ### [TASK] Move ObjectManager to constructor in AbstractFacet (TYPO3-Solr#3235) As long as EXT:solr doesn't support DI and the ObjectManager is still required, the ObjectManager is set/instantiated in the constructor, preventing initialization issues. ### [TASK] Allow SearchResultSetService instantiation via makeInstance Extbase ObjectManager is deprecated and should be replaced, but as EXT:solr doesn't support DI yet and makeInstance doesn't support a mixture of manual set parameters and DI, the instantiation of the local ObjectManager of SearchResultSetService is changed and now also done in the constructor. With this change SearchResultSetService can now be instantiated via makeInsstance, even DI is not yet configured. ### [TASK] Prevent type errors Prevent type errors by ensuring the right types is used. ### [DOCS] Align with new TYPO3 documentation standards (TYPO3-Solr#3242) ### [DOCS] Align README.md with other extensions (TYPO3-Solr#3218) Reduce README.md to an abstract and links to important pages that cover the user's next steps, especially the full documentation and TER page for installation, but also add-ons and the paid services. ### [BUGFIX] Missing dot in configuration in numberOfResultsPerGroup method (TYPO3-Solr#3098) ### [BUGFIX] Add type cast to TaskProviders Fix exception which happens with PHP8 because the returned page id is actually a string but an integer is required ### [TASK] Improve error handling in index queue module Not all kind of errors while initializing the index queue are currently handled and so an error page or debug trace might be shown. This commit adds an additional check and implements a more pleasant error message. ## Known issues: * TYPO3-Solr#3166 ## Open tasks: * TYPO3-Solr#3160 * TYPO3-Solr#3169 * TYPO3-Solr#3220 ## Note for non-composer instances: This release candidate is not available in TYPO3 TER, if you want to try this release, please download and install this release manually from: * https://github.com/TYPO3-Solr/ext-solr/releases/tag/11.5.0-rc-2 --- # How to Get Involved There are many ways to get involved with Apache Solr for TYPO3: * Submit bug reports and feature requests on GitHub * Ask or help or answer questions in our Slack channel * Provide patches through pull requests or review and comment on existing pull requests * Go to www.typo3-solr.com or call dkd to sponsor the ongoing development of Apache Solr for TYPO3 Support us by becoming an EB partner: https://shop.dkd.de/Produkte/Apache-Solr-fuer-TYPO3/ or call: +49 (0)69 - 2475218 0
dkd-friedrich
added a commit
to dkd-friedrich/ext-solr
that referenced
this pull request
Nov 2, 2022
This is a maintaine release for TYPO3 10.4, containing: - [BUGFIX] Prepend wrong fe language on empty cache (TYPO3-Solr#3375) - [TASK] Use TYPO3 IpAnonymizationUtility (TYPO3-Solr#3262) - [BUGFIX:BP:11.2] Shortcircuit work in SolrRoutingMiddleware (TYPO3-Solr#3202) - [TASK] Fix scrutinizer on release-11.2.x - [BUGFIX:BP:11.2] Do not handle page updates on new page with uid 0 (TYPO3-Solr#3338) - [TASK] Remove not used strptime() adaption for windows. - [BUGFIX] Respect indexing configuration for new and updated subpages (TYPO3-Solr#3276) - [BUGFIX] Ensure keywords string does not exceed database field length (TYPO3-Solr#3321) - [TASK:BP:11.2] Adapt column arrangement within sites config (TYPO3-Solr#3295) - [DOCS:BP:11.2] add missing doc for ..pageIndexed (#) - [BUGFIX] Fix PSR-4 Namespaces and Paths (TYPO3-Solr#3285) - [BUGFIX] Silence DebugWriter for PageIndexerRequest (TYPO3-Solr#3030) - [BUGFIX] AbstractSolrTask::setRootPageId(): Argument TYPO3-Solr#1 () must be of type int, string given (TYPO3-Solr#3267) - [BUGFIX:11.2] Update GarbageCollector.php (TYPO3-Solr#3249) - [DOCS] Align with new TYPO3 documentation standards (TYPO3-Solr#3242) - [DOCS] Align README.md with other extensions (TYPO3-Solr#3218) - [BUGFIX] Missing dot in configuration in numberOfResultsPerGroup method (TYPO3-Solr#3098 - [TASK] Added info about using page content in fields - [TASK] Added info about the virtual field __solr_contents - [BUGFIX:BP:11.2] Fix write connection (TYPO3-Solr#2916) Please read the release notes: https://github.com/TYPO3-Solr/ext-solr/releases/tag/11.1.3 --- How to Get Involved There are many ways to get involved with Apache Solr for TYPO3: Submit bug reports and feature requests on GitHub Ask or help or answer questions in our Slack channel Provide patches through Pull Request or review and comment on existing Pull Requests Go to www.typo3-solr.com or call dkd to sponsor the ongoing development of Apache Solr for TYPO3 Support us by becoming an EB partner: https://shop.dkd.de/Produkte/Apache-Solr-fuer-TYPO3/ or call: +49 (0)69 - 2475218 0
dkd-friedrich
added a commit
to dkd-friedrich/ext-solr
that referenced
this pull request
Nov 2, 2022
This is a maintenance release for TYPO3 10.4, containing: - [BUGFIX] Prepend wrong fe language on empty cache (TYPO3-Solr#3375) - [TASK] Use TYPO3 IpAnonymizationUtility (TYPO3-Solr#3262) - [BUGFIX:BP:11.2] Shortcircuit work in SolrRoutingMiddleware (TYPO3-Solr#3202) - [TASK] Fix scrutinizer on release-11.2.x - [BUGFIX:BP:11.2] Do not handle page updates on new page with uid 0 (TYPO3-Solr#3338) - [TASK] Remove not used strptime() adaption for windows. - [BUGFIX] Respect indexing configuration for new and updated subpages (TYPO3-Solr#3276) - [BUGFIX] Ensure keywords string does not exceed database field length (TYPO3-Solr#3321) - [TASK:BP:11.2] Adapt column arrangement within sites config (TYPO3-Solr#3295) - [DOCS:BP:11.2] add missing doc for ..pageIndexed (#) - [BUGFIX] Fix PSR-4 Namespaces and Paths (TYPO3-Solr#3285) - [BUGFIX] Silence DebugWriter for PageIndexerRequest (TYPO3-Solr#3030) - [BUGFIX] AbstractSolrTask::setRootPageId(): Argument TYPO3-Solr#1 () must be of type int, string given (TYPO3-Solr#3267) - [BUGFIX:11.2] Update GarbageCollector.php (TYPO3-Solr#3249) - [DOCS] Align with new TYPO3 documentation standards (TYPO3-Solr#3242) - [DOCS] Align README.md with other extensions (TYPO3-Solr#3218) - [BUGFIX] Missing dot in configuration in numberOfResultsPerGroup method (TYPO3-Solr#3098 - [TASK] Added info about using page content in fields - [TASK] Added info about the virtual field __solr_contents - [BUGFIX:BP:11.2] Fix write connection (TYPO3-Solr#2916) Please read the release notes: https://github.com/TYPO3-Solr/ext-solr/releases/tag/11.2.1 --- How to Get Involved There are many ways to get involved with Apache Solr for TYPO3: Submit bug reports and feature requests on GitHub Ask or help or answer questions in our Slack channel Provide patches through Pull Request or review and comment on existing Pull Requests Go to www.typo3-solr.com or call dkd to sponsor the ongoing development of Apache Solr for TYPO3 Support us by becoming an EB partner: https://shop.dkd.de/Produkte/Apache-Solr-fuer-TYPO3/ or call: +49 (0)69 - 2475218 0
dkd-friedrich
added a commit
to dkd-friedrich/ext-solr
that referenced
this pull request
Nov 2, 2022
This is a maintenance release for TYPO3 10.4, containing: - [BUGFIX] Prepend wrong fe language on empty cache (TYPO3-Solr#3375) - [TASK] Use TYPO3 IpAnonymizationUtility (TYPO3-Solr#3262) - [BUGFIX:BP:11.2] Shortcircuit work in SolrRoutingMiddleware (TYPO3-Solr#3202) - [TASK] Fix scrutinizer on release-11.2.x - [BUGFIX:BP:11.2] Do not handle page updates on new page with uid 0 (TYPO3-Solr#3338) - [TASK] Remove not used strptime() adaption for windows. - [BUGFIX] Respect indexing configuration for new and updated subpages (TYPO3-Solr#3276) - [BUGFIX] Ensure keywords string does not exceed database field length (TYPO3-Solr#3321) - [TASK:BP:11.2] Adapt column arrangement within sites config (TYPO3-Solr#3295) - [DOCS:BP:11.2] add missing doc for ..pageIndexed - [BUGFIX] Fix PSR-4 Namespaces and Paths (TYPO3-Solr#3285) - [BUGFIX] Silence DebugWriter for PageIndexerRequest (TYPO3-Solr#3030) - [BUGFIX] AbstractSolrTask::setRootPageId(): Argument TYPO3-Solr#1 must be of type int, string given (TYPO3-Solr#3267) - [BUGFIX:11.2] Update GarbageCollector.php (TYPO3-Solr#3249) - [DOCS] Align with new TYPO3 documentation standards (TYPO3-Solr#3242) - [DOCS] Align README.md with other extensions (TYPO3-Solr#3218) - [BUGFIX] Missing dot in configuration in numberOfResultsPerGroup method (TYPO3-Solr#3098 - [TASK] Added info about using page content in fields - [TASK] Added info about the virtual field __solr_contents - [BUGFIX:BP:11.2] Fix write connection (TYPO3-Solr#2916) Please read the release notes: https://github.com/TYPO3-Solr/ext-solr/releases/tag/11.2.1 --- How to Get Involved There are many ways to get involved with Apache Solr for TYPO3: Submit bug reports and feature requests on GitHub Ask or help or answer questions in our Slack channel Provide patches through Pull Request or review and comment on existing Pull Requests Go to www.typo3-solr.com or call dkd to sponsor the ongoing development of Apache Solr for TYPO3 Support us by becoming an EB partner: https://shop.dkd.de/Produkte/Apache-Solr-fuer-TYPO3/ or call: +49 (0)69 - 2475218 0
dkd-friedrich
added a commit
that referenced
this pull request
Nov 2, 2022
This is a maintenance release for TYPO3 10.4, containing: - [BUGFIX] Prepend wrong fe language on empty cache (#3375) - [TASK] Use TYPO3 IpAnonymizationUtility (#3262) - [BUGFIX:BP:11.2] Shortcircuit work in SolrRoutingMiddleware (#3202) - [TASK] Fix scrutinizer on release-11.2.x - [BUGFIX:BP:11.2] Do not handle page updates on new page with uid 0 (#3338) - [TASK] Remove not used strptime() adaption for windows. - [BUGFIX] Respect indexing configuration for new and updated subpages (#3276) - [BUGFIX] Ensure keywords string does not exceed database field length (#3321) - [TASK:BP:11.2] Adapt column arrangement within sites config (#3295) - [DOCS:BP:11.2] add missing doc for ..pageIndexed - [BUGFIX] Fix PSR-4 Namespaces and Paths (#3285) - [BUGFIX] Silence DebugWriter for PageIndexerRequest (#3030) - [BUGFIX] AbstractSolrTask::setRootPageId(): Argument #1 must be of type int, string given (#3267) - [BUGFIX:11.2] Update GarbageCollector.php (#3249) - [DOCS] Align with new TYPO3 documentation standards (#3242) - [DOCS] Align README.md with other extensions (#3218) - [BUGFIX] Missing dot in configuration in numberOfResultsPerGroup method (#3098 - [TASK] Added info about using page content in fields - [TASK] Added info about the virtual field __solr_contents - [BUGFIX:BP:11.2] Fix write connection (#2916) Please read the release notes: https://github.com/TYPO3-Solr/ext-solr/releases/tag/11.2.1 --- How to Get Involved There are many ways to get involved with Apache Solr for TYPO3: Submit bug reports and feature requests on GitHub Ask or help or answer questions in our Slack channel Provide patches through Pull Request or review and comment on existing Pull Requests Go to www.typo3-solr.com or call dkd to sponsor the ongoing development of Apache Solr for TYPO3 Support us by becoming an EB partner: https://shop.dkd.de/Produkte/Apache-Solr-fuer-TYPO3/ or call: +49 (0)69 - 2475218 0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reduce README.md to an abstract and links to important pages
that cover the user's next steps, especially the full
documentation and TER page for installation, but also add-ons
and the paid services.
The details of the contribution are already in CONTRIBUTION.md
and in the full documentation - and obvious if you look at the
git history.
The contact details should be moved to the full documentation.
Keep outgoing links to a minimum to not distract the user.
Related: TYPO3-Documentation/T3DocTeam#182