cakephp / cakephp/phinx

Rewrite documentation examples from yaml to php

Open
#1,923 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
4.5k
Forks
884
PR merge metrics
No merged PRs in 30d

Description

Originally posted by @christhomas in https://github.com/cakephp/phinx/issues/1726#issuecomment-724665219

I understand that you wanna get rid of a dependency by moving to plain php, but all the documentation on the cakephp website and that I've found so far is using YAML, so I don't know what a php configuration would look like with all the %%OPTIONS%% etc, etc. I think this change was half baked. You broke a lot of stuff without much explanation and have no way to migrate one to the other, and no documentation updates to reflect that.

Given that the default configuration option is now PHP, it would be good to rewrite all configuration examples to be in PHP. The translation from PHP to YAML / JSON would be left as an exercise to the reader, but given that it's just nested arrays, lists, and strings, should be fairly simple by end-user. Can re-address if this is any issue to people.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation configuration examples and compare them with the now-default PHP configuration described in the issue. Rewrite the examples in PHP, leaving YAML/JSON translation to readers, and verify that all configuration examples consistently reflect the default format.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.