Skip to content

Some wording improvements, clarifications, etc. #10180

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 18 commits into from

Conversation

ThomasLandauer
Copy link
Contributor

No description provided.

Reason: I think the docs should show a *minimal* working example. The user needs to customize it anyway, so coming up with a bells-and-whistles solution only makes the entire process look more complicated than it is.

I entered the "Add new tag" link into the HTML directly, cause I couldn't see any benefit of having it added dynamically.

I didn't update the JSFiddle though.

I'm not finished yet - this code might break the JavaScript further down the page (the "remove tag" link)
@ThomasLandauer
Copy link
Contributor Author

Question: I'm not sure about this line:

newForm = newForm.replace(/__name__label__/g, index);

I can never see __name__label__ in my prototype (Symfony 4.1), no matter if I set 'entry_options' => array('label' => false) or not. Was this feature maybe removed?

And I don't even see what its point would have been. Put the index inside the label? Why?

@ThomasLandauer
Copy link
Contributor Author

Started with some minor corrections, ended up with a major reorganization ;-)

I'm done for now, please merge.

@weaverryan
Copy link
Member

Hey @ThomasLandauer!

This is awesome! Sorry for the delay - these big changes are hard to review. Do you have a test repository where you built the code? We really need to code through this to make sure everything still works properly.

Cheers!

@ThomasLandauer
Copy link
Contributor Author

Do you have a test repository where you built the code?

No, I entered everything on GitHub's website. But I didn't change the actual code that much - just moved stuff around ;-)

@weaverryan
Copy link
Member

Ah, ok! Were there any parts of the code that you changed in any significant way? The diff in these re-org PR's is hard to check (I'm the king of massively re-organizing stuff, so that's not a complaint about your PR!)

@ThomasLandauer
Copy link
Contributor Author

To be honest: I don't really remember :-( But I guess not, I think I just explained things better.

@xabbuh xabbuh added this to the 2.8 milestone Sep 3, 2018
@ThomasLandauer
Copy link
Contributor Author

I need this functionality for another project in a few days. If you could merge it till then, I could double-check if everything's all right. But I'd need it on the real website - can't work with this GitHub "preview" ;-)

@ThomasLandauer
Copy link
Contributor Author

Do you want me to set up a repository as explained at https://symfony.com/doc/current/contributing/code/reproducer.html ?

@OskarStark
Copy link
Contributor

Hi @ThomasLandauer 👋

Do you want me to set up a repository as explained at

That would be cool!

@OskarStark
Copy link
Contributor

Hey Thomas 😊

We really appreciate your work, but the 2.8 branch isn’t maintained anymore. Please rebase on 3.4 branch first, most of the things are already fixed and we don’t want to waste your time.

Anyway thanks for your help 👌🏻

Cheers, Oskar

@ThomasLandauer
Copy link
Contributor Author

See https://github.com/ThomasLandauer/symfony-docs_pr_10180

Sorry, I don't know how to rebase :-(
And I must say: I finished this over a year (!) ago, but nobody merged it. And you told me just 5 weeks ago to create the repo. So I've done that.

So please help me out now, I spent hours for this!

@ThomasLandauer
Copy link
Contributor Author

Suggestion: Separate headings for all possible relationship types.

Right now, the page contains too many "In case you have A, you need to pay attention to B, etc.". In this phase (i.e. when the user thinks about setting up an "add" button"), the database model is fixed anyway! Nobody will say "Well, if it's easier to get the button, let's change the relationship type!"

So wouldn't it be better to take the relationship type as granted and give a step-by-step tutorial for each type?

@OskarStark
Copy link
Contributor

Hi Thomas 👋

I am sorry, but I will to close here, 2.8 isn't maintained for a long time.
We really appreciate your work on the docs, but I would recommend to make more smaller changes instead of one of such size.

Thank you for your understanding!

Cheers, Oskar

@OskarStark OskarStark closed this Nov 14, 2019
@ThomasLandauer
Copy link
Contributor Author

July 30:

Do you want me to set up a repository as explained at

That would be cool!

November 14:

I am sorry, but I will to close here

@OskarStark
Copy link
Contributor

Hi Thomas,

I am sorry but you offered todo this and I just wanted to say "yes that would be great and more easy for the one who will help you", so I saw my position more or less to be a moderator on topics/issues/pull requests. Sorry for being not clear enough and you thought, that I could help you out.
Maybe I mixed things up (because there are so much issues/pull requests I am working on) as a reproducer is mainly helpful for a code issue, but not for docs.

My recommendation is still to provide small pull requests, your last one was merged really quickly (grammar, typo IIRC).

Cheers, Oskar

@ThomasLandauer
Copy link
Contributor Author

I don't know who of you is in charge of what! This isn't documented anywhere (or is it?) So if somebody tells me to do something, I usually do it. Oskar, I can't know which role you're playing in the entire game. What I'm blaming you, personally, was to tell me to put more work into this, at a time when it was (I'm 99% sure about this) already futile.

The same is eventually going to happen to #11222 and #11223 :-(

Small PR's:
By fixing typos you will never get great documentation. You will get mediocre documentation without typos.
So if it's hard to review large changes, you need to come up with a better workflow/solution/whatever! Cause right now, you're essentially saying: "Go find some errors, but leave the important stuff up to us!"

@OskarStark
Copy link
Contributor

The same is eventually going to happen to #11222 and #11223 :-(

Eventually.. yes.. 😞

By fixing typos you will never get great documentation.

Sorry but many users are very very happy with the Symfony documentation, so personally I am convinced, that we are doing good work.
You have your opinion and I have my opinion, this is be fine and should allowed 👍

And please remember we are doing all this beside our main jobs ❗️ without any payment ❗️ in our freetime ❗️

Have a good day ☀️
oskar

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.

6 participants