TYPO3-Documentation / T3DocTeam

This repository is for the Documentation Team. To contribute, please see CONTRIBUTING.md For help and support on TYPO3, please see: https://typo3.org/help/
3 stars 1 forks source link

Add extension redirects or report problems with extension documentation rendering #92

Closed sypets closed 2 years ago

sypets commented 5 years ago

New: For new extensions, a message is sent automatically to the #typo3-documentation Slack channel. So, if all goes well, there is no need to use this issue.

You can comment in this issue if you need redirects for your extension documentation or there are problems with rendering your documentation.

Alternatively, you can use Slack.


More information: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocForExtension/Migrate.html


If you don't want further notifications, just unsubscribe from notification via right sidebar in this issue.

fsuter commented 5 years ago

cobwebch/external_import

Thanks!

sypets commented 5 years ago

@fsuter done. Thanks for reporting!

https://docs.typo3.org/typo3cms/extensions/external_import/stable/ -> https://docs.typo3.org/p/cobweb/external_import/master/en-us/

sebkln commented 5 years ago

sebkln/ajaxselectlist

Thank you!

sypets commented 5 years ago

@sebkln It appears your extension has not been rendered yet with the new mechanism. Can you confirm? It think the URL for the rendered documentation should be:

https://docs.typo3.org/p/sebkln/ajaxselectlist/master/en-us/

Something went wrong. I can see a webhook ping, but nothing else:

https://intercept.typo3.com/admin/docs/deployments

intercept

  1. Can you please check your webhook?

    https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocForExtension/Webhook.html

  2. And you might have to push another change to your repository.

    Every push to this branch (master) triggers a new rendering, available at https://docs.typo3.org/p///master/en-us/.

  3. Wait a few minutes and check on Intercept again: https://intercept.typo3.com/admin/docs/deployments

Once Intercept renders, you should see a log entry for your extension.

If this does not help, best to ask on Slack: #typo3-documentation

  1. Get typo3.org account
  2. Register for Slack: https://my.typo3.org/about-mytypo3org/slack
  3. join #typo3-documentation channel.
sebkln commented 5 years ago

@sypets Thank you for your detailed answer!

I just needed to push another commit in my repository. The documentation was then rendered right away.

sypets commented 5 years ago

@sebkln redirect is working.

fnagel commented 5 years ago

Thank you!

DanielSiepmann commented 5 years ago

@fnagel redirects are in place.

metacontext commented 5 years ago

Thanks a lot!

sypets commented 5 years ago

@metacontext

redirect for digicademy/beaconizer is in place

anjeylink commented 5 years ago

Thank you.

anjeylink commented 5 years ago

https://docs.typo3.org/typo3cms/extensions/pxa_social_feed/stable/ -> https://docs.typo3.org/p/pixelant/pxa-social-feed/master/en-us/

DanielSiepmann commented 5 years ago

@anjeylink redirects for both extensions are in place.

metacontext commented 5 years ago

Thank you very much!

sypets commented 5 years ago

@metacontext

It seems cobj_xpath is not rendered yet with new rendering mechanism. If I am not mistaking, URL should be https://docs.typo3.org/p/digicademy/cobj_xpath/master/en-us/

Same goes for cobj_xslt.

See https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocForExtension/Migrate.html

  1. Please check if you have added the webhook.
  2. After that, you might have to push again
  3. Look on Intercept: https://intercept.typo3.com/admin/docs/deployments

intercept

metacontext commented 5 years ago

@sypets, thanks for your detailed feedback. Indeed, I forgot to create the new webhooks for both extensions, sorry. Now done and according to Intercept the documentation is now rendered. Thanks for creating the redirects.

federicobernardin commented 5 years ago

Please

sypets commented 5 years ago

@metacontext done!

sypets commented 5 years ago

btw I am no longer adding the extensions to the list in the first comment. It is extra work, I think it is unnecessary. We (doc team) can easily view existing redirects.

sypets commented 5 years ago

@federicobernardin done

https://docs.typo3.org/typo3cms/extensions/t3registration/stable/ -> https://docs.typo3.org/p/pallino/t3registration/master/en-us/

ghost commented 5 years ago

@federicobernardin done

https://docs.typo3.org/typo3cms/extensions/t3registration/stable/ -> https://docs.typo3.org/p/pallino/t3registration/master/en-us/

Many thanks!!!!

Bunnyfield commented 5 years ago

I'm not sure though if this is the right place to go when the documentation link in the TER detail view is missing.

Zillion01 commented 5 years ago

Please,

sypets commented 5 years ago

@Bunnyfield There is no reference of the localizer extension rendered via the legacy URL (e.g. https://docs.typo3.org/typo3cms/extensions/localizer/stable/), so there is nothing to redirect.

The URL in the TER detail view should update itself automatically. Looks good: https://extensions.typo3.org/extension/localizer/ points to https://docs.typo3.org/p/localizationteam/localizer/master/en-us/

For the URL in the TER search result view, there is still an open issue, see https://git-t3o.typo3.org/t3o/ter/issues/405

Nothing to do here. Please let us know if this changes or something is missing.

sypets commented 5 years ago

@Zillion01 jpfaq: done

VeraSpiegel commented 5 years ago
sypets commented 5 years ago

@VeraSpiegel I cannot find your extension in the deployment list on https://intercept.typo3.com/admin/docs/deployments

Did you add the Webhook? https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocForExtension/Migrate.html

After adding the Webhook, you must push again to initiate rendering.

Come to Slack channel #typo3-documentation if you have questions: https://typo3.org/community/teams/documentation/#c9886

ghermens commented 5 years ago

Thanks in advance...

albig commented 5 years ago

We need redirect for

Thank you!

ghermens commented 5 years ago

Thanks in advance...

featdd commented 4 years ago

Hello,

would you be so kind to add some redirects:

Thanks and greetings Daniel

sypets commented 4 years ago

@featdd I already did. Does not solve the problem with "forbidden" 403, though. But I posted a comment in #typo3-documentation on Slack.

albig commented 4 years ago

@sypets Did you see my comment above? The redirects still don't exists.

sypets commented 4 years ago

@albig sorry about that and thanks for the reminder. Is done now!

sypets commented 4 years ago

@albig about dfgviewer: you might want to add some text about what the extension does (that is totally up to you but I noticed it is missing). There is also a problem with the rendering of the menu. This will be fixed shortly, see also Slack #typo3-documentation

mieserfettsack commented 4 years ago
sypets commented 4 years ago

@mieserfettsack The URL https://docs.typo3.org/p/mdy/costumcontentpreview/master/en-us does not exist yet. The extension has not been rendered yet. You can see current status in https://intercept.typo3.com/admin/docs/deployments

This means it is pending approval by us. Please wait ...

TehTux commented 4 years ago

Thanks!

fnagel commented 4 years ago

Please add following projects:

One question: is there the possibility to add all valid versions to the version selector? For example my blog extension is valid from 2.2.2-4.1.0 but only 4.0 and 4.1 are shown in the selector. Any idea why?

https://extensions.typo3.org/extension/t3extblog/ https://docs.typo3.org/p/felixnagel/t3extblog/4.1/en-us/

Thanks for your hard work and making TYPO3 better <3

sypets commented 4 years ago

@TehTux haffner/jh_captcha done

sypets commented 4 years ago

@fnagel

Currently rendered under vendor name "felixnagel" I can find privacyguard, deletefiles. Redirects are in place.

I cannot find beautyofcode, generic-gallery or pluploadfe on intercept.typo3.com.

I rechecked latest composer.json : same result (the 3 missing extension docs are only rendered with "old" mechanism).

Please check if webhook is configured and working. You may have to trigger rendering by pushing another change.

See

About your question about the older versions: I don't know. It should work. I will try to investigate.

sypets commented 4 years ago

@ghermens amazing/media2click + amazing/gh_randomcontent done

sypets commented 4 years ago

@fnagel Please retrigger rendering by pushing again, see Slack

fnagel commented 4 years ago

@sypets Thanks a lot for your help!

All extension have fnagel as GitHub username and felixnagel as vendor in composer.json. I followed the same steps like I did for my other extensions (following your formidable migration guide).

I've just checked if the hooks are in place and they are. There are multiple green checked entries in the "Recent Deliveries" within the GitHub Webhook settings. And I'm pretty sure I've seen this "Docs hook ping from github repository..." message on intercept after my initial push.

Anyway, I've pushed a change for "beautyofcode" as a test. Seems I need to change the doc files in order to force a rendering, right?

Here are some screens:

boc - this seems to be related to my extension.

boc-gh - GitHub hook settings

fnagel commented 4 years ago

@sypets @DanielSiepmann Would you please check my last comment? Thanks a lot!

colorcube commented 4 years ago

colorcube/shredder intercept says "Awaiting Approval"

sypets commented 4 years ago

@colorcube Accepted :thumbsup:

Is now rendered: https://docs.typo3.org/p/colorcube/shredder/master/en-us/

Redirect created

colorcube commented 4 years ago

please add following extensions

colorcube commented 4 years ago

please add

colorcube/anfahrt

(seems to be forgotten)

DanielSiepmann commented 4 years ago