ably-php-laravel icon indicating copy to clipboard operation
ably-php-laravel copied to clipboard

Update official laravel website doc with laravel-broadcaster

Open sacOO7 opened this issue 3 years ago • 4 comments
trafficstars

  • laravel-broadcaster supports laravel > 6.
  • This requires updating official laravel web documentation with laravel-broadcaster usage which includes official ably library announcement section. This might also include marking old ably related doc as deprecated.
  • Make PR's to update the following docs
  1. https://laravel.com/docs/6.x/broadcasting

    PR from https://github.com/ably-forks/laravel-docs/blob/6.x/broadcasting.md against https://github.com/laravel/docs/blob/6.x/broadcasting.md

  2. https://laravel.com/docs/7.x/broadcasting

    PR from https://github.com/ably-forks/laravel-docs/blob/7.x/broadcasting.md against https://github.com/laravel/docs/blob/7.x/broadcasting.md

  3. https://laravel.com/docs/8.x/broadcasting

    PR from https://github.com/ably-forks/laravel-docs/blob/8.x/broadcasting.md against https://github.com/laravel/docs/blob/8.x/broadcasting.md

  4. https://laravel.com/docs/9.x/broadcasting

    PR from https://github.com/ably-forks/laravel-docs/blob/9.x/broadcasting.md against https://github.com/laravel/docs/blob/9.x/broadcasting.md

Also make a PR against the master branch, which is reserved for the next 10.x release

PR from https://github.com/ably-forks/laravel-docs/blob/master/broadcasting.md against https://github.com/laravel/docs/blob/master/broadcasting.md

We are updating docs as per comment by laravel founder on one of our old PR's -> https://github.com/laravel/framework/pull/43685#issuecomment-1267103189/ . So, it might be needed to include this comment as a part of each PR description.

Imp Note - It might be helpful to refer to old doc PR -> https://github.com/ably-forks/laravel-docs/pull/1

┆Issue is synchronized with this Jira Task by Unito

sacOO7 avatar Oct 31 '22 06:10 sacOO7

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-2891

sync-by-unito[bot] avatar Oct 31 '22 06:10 sync-by-unito[bot]

  • For 8.x and 9.x , follow this PR as is -> https://github.com/laravel/docs/pull/8120

  • For 6x. and 7.x, just need to remove deprecation section from the PR

  • Create 5 branches for now

  1. 6.x/doc-ably-broadcaster against 6.x
  2. 7.x/doc-ably-broadcaster against 7.x
  3. 8.x/doc-ably-broadcaster against 8.x
  4. 9.x/doc-ably-broadcaster against 9.x
  5. master/doc-ably-brodcaster against master
  • All of these PRs will live inside https://github.com/ably-forks/laravel-docs/
  • Get them reviewed and then again create PR against https://github.com/laravel/docs

sacOO7 avatar Nov 17 '22 20:11 sacOO7

  • Create the same types of PRs for https://github.com/laravel/laravel describing changes in environment variables while creating the app. e.g. https://github.com/laravel/laravel/pull/5969/files - This PR also needs to be updated.

  • So, there will be 5 more PR's

sacOO7 avatar Nov 27 '22 19:11 sacOO7

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/ECO-4056

sync-by-unito[bot] avatar Feb 17 '24 18:02 sync-by-unito[bot]