Skip to content

[WIP] Integrating UX docs more closely into Symfony docs #16404

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.

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

Merged
merged 0 commits into from
Jan 31, 2022

Conversation

weaverryan
Copy link
Member

@weaverryan weaverryan commented Jan 17, 2022

Hi!

Partner to symfony/ux#225

TODO

Copy link
Member

@wouterj wouterj left a comment

Choose a reason for hiding this comment

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

This is great, thanks Ryan! The stream of awesome contributions from you just doesn't stop the past months :)

Two other points:

  • Let's update the "Symfony UX initiative" link in the form type reference to point to /frontend/ux
  • Please rebase this PR to remove the merge commit

weaverryan added a commit to symfony/ux that referenced this pull request Jan 21, 2022
…y.com (weaverryan)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[WIP] Refactoring all docs to .rst files to host on symfony.com

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Tickets       | None
| License       | MIT

This preps the docs so that they can be hosted on symfony.com/bundles.

TODO:
* [X] a partner PR on symfony-docs to update some URLs and other things there symfony/symfony-docs#16404
* [x] Javier to be ready to integrate this into symfony.com after merge

Commits
-------

71a9db3 Merge branch '2.x' into rst_docs
e6aeda3 minor docs tweaks
604f177 delegating most of main README to Symfony docs
86ba8ab linking to new UX section
fb05d24 Refactoring all docs to .rst files to host on symfony.com
@weaverryan
Copy link
Member Author

Ready to go again :)

@weaverryan weaverryan force-pushed the ux-docs-in-bundles-section branch from 3631213 to 6ed2e71 Compare January 25, 2022 19:03
@wouterj
Copy link
Member

wouterj commented Jan 25, 2022

Thanks @weaverryan!

Is there a reason to target 5.4 here, instead of 5.3 or 4.4? Afaik, UX is available in all versions :)

@weaverryan
Copy link
Member Author

Just that we, I think, typically target the "current Symfony version" for new docs, right? To avoid extra pain merging up from old branches? But certainly, I could target something older. WDYT?

@javiereguiluz
Copy link
Member

Ryan, I understand what you say ... but we always merge UX things in 4.4 because they are disconnected from Symfony versioning. Note that if, for any reason, it's complicated for us to write these docs for 4.4, we can change this practice. Thanks!

@weaverryan weaverryan force-pushed the ux-docs-in-bundles-section branch from 6ed2e71 to 0fcdb32 Compare January 26, 2022 15:07
@weaverryan weaverryan changed the base branch from 5.4 to 4.4 January 26, 2022 15:07
@weaverryan weaverryan force-pushed the ux-docs-in-bundles-section branch from 0fcdb32 to ba6ac09 Compare January 26, 2022 15:09
@wouterj
Copy link
Member

wouterj commented Jan 26, 2022

Note that I wanted to merge this in 5.3 yesterday (4.4 gave lots of conflicts) and then discovered that Turbo and "Stimulus & Symfony UX" also wasn't merged in 5.3.

As far as I know, we've only applied the practice to only update the latest version for a very brief time and are updating older versions again.

EDIT: removed the demotivating text as you've updated this PR to target 4.4 already 🚀 :)

@weaverryan
Copy link
Member Author

No problem - it seems very pragmatic :).

As you mentioned, some things didn't exist on 4.4. So simple-example.rst is now a copy of what I had proposed on 5.4, so it also contains a bunch of unrelated changes.

But, this should be ready I think :)

@weaverryan weaverryan modified the milestones: 5.4, 4.4 Jan 31, 2022
@weaverryan weaverryan closed this Jan 31, 2022
@weaverryan weaverryan force-pushed the ux-docs-in-bundles-section branch from 2d666a1 to 4177f81 Compare January 31, 2022 18:39
@weaverryan weaverryan merged commit 7e32fb0 into symfony:4.4 Jan 31, 2022
@weaverryan weaverryan deleted the ux-docs-in-bundles-section branch January 31, 2022 19:16
weaverryan added a commit that referenced this pull request Feb 1, 2022
This PR was merged into the 5.4 branch.

Discussion
----------

[4.4][UX] Removing extra links from rebasing

Hi!

I merged #16404 a bit too quickly. I had rebased that from 5.4 to 4.4, and when I did, I duplicated a few things that I should not have. This fixes that :).

Cheers!

Commits
-------

c6d8d26 Removing extra links from rebasing
jameswebapp added a commit to jameswebapp/ux that referenced this pull request Aug 1, 2023
…y.com (weaverryan)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[WIP] Refactoring all docs to .rst files to host on symfony.com

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Tickets       | None
| License       | MIT

This preps the docs so that they can be hosted on symfony.com/bundles.

TODO:
* [X] a partner PR on symfony-docs to update some URLs and other things there symfony/symfony-docs#16404
* [x] Javier to be ready to integrate this into symfony.com after merge

Commits
-------

71a9db3 Merge branch '2.x' into rst_docs
e6aeda3 minor docs tweaks
604f177 delegating most of main README to Symfony docs
86ba8ab linking to new UX section
fb05d24 Refactoring all docs to .rst files to host on symfony.com
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants