Skip to content

adding docs about configurable flex paths #11114

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

Closed
wants to merge 1 commit into from

Conversation

weaverryan
Copy link
Member

Hi friends!

Flex is a bit configurable, but it wasn't documented anywhere.

See https://twitter.com/beausimensen/status/1101863042797789192

Copy link
Contributor

@HeahDude HeahDude left a comment

Choose a reason for hiding this comment

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

Really nice addition, thanks!


If you customize these paths, some files copied from a recipe still may contain
references to the original path. In other words: you may need to update some things
manually after a recipe is installed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should also note that official recipes do not need such extra treatment, because they use %PUBLIC_DIR% placeholder.
We could even mention that cause as advice for creating custom/contributed recipes.

Copy link
Member

Choose a reason for hiding this comment

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

@HeahDude are you saying that using things like %PUBLIC_DIR% is mandatory for official recipes but not for community recipes? Why? It should be mandatory for both, right?

Copy link
Contributor

@HeahDude HeahDude Mar 11, 2019

Choose a reason for hiding this comment

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

are you saying that using things like %PUBLIC_DIR% is mandatory for official recipes but not for community recipes

No I'm not 😅
Just saying that we should document that fact too while documenting contrib recipes here https://github.com/symfony/recipes/blob/master/README.rst#copy-from-recipe-configurator.
It's shown in the example but never really explained.
If we were to do it here I suggest to add a note and even a link to that section.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks. I've created symfony/recipes#545 to better explain this ... but I don't think we should add more links between them. Each repo explains this a bit differently to adapt to their readers.

@HeahDude HeahDude added the Flex label Mar 8, 2019
@HeahDude HeahDude added this to the 3.4 milestone Mar 8, 2019
@OskarStark
Copy link
Contributor

Why did you add this to the 3.4 milestone @HeahDude?
4.2 is targeted here 🤔

@HeahDude
Copy link
Contributor

Yes the target branch should be changed ;).

@javiereguiluz
Copy link
Member

Thanks Ryan! Merged it in 3.4.

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.

5 participants