Skip to content

Add flag to show both configuration styles (Java and XML) in reference docs #572

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 2 commits into from
Closed

Conversation

Buzzardo
Copy link

I edited the leader paragraphs above each code block that was flagged as being XML or Java content, such that the paragraphs make sense when both the XML and the Java blocks are present. I turned the Both button back on. I also caught a bunch of other editing things.

@fmbenhassine
Copy link
Contributor

I tested this PR and noticed that the "Both" option will introduce some repetitive sentences making the documentation not coherent:

screenshot 2018-12-13 at 12 42 36

Moreover, we need to make sure every section having a role corresponds to its snippet and test it with the "Both" option to avoid inconsistencies like the following one:

screenshot 2018-12-13 at 12 40 11

To be honest, I don't see the added value of this "Both" option, at least with the current design. May be we can update the style to show snippets side by side, but still.

@Buzzardo @mminella What do you think?

@Buzzardo
Copy link
Author

Those are errors we need to correct. I'll make a new PR for them.

@Buzzardo
Copy link
Author

Do you want an issue for this or is it too simple for that?

@fmbenhassine
Copy link
Contributor

No need for an issue or a new PR. You can fix those in this PR so we merge a coherent change set at once.

@Buzzardo
Copy link
Author

Hi, Mahmoud,

That was tricky. I had to rephrase a bit to make it make sense and still keep the key information. I also fixed a couple grammatical errors that I caught while I was there.

Please check this commit closely, as I had to resolve a bunch of conflicts due to the age of the original commit. I THINK I got everything right, but please do check.

Thanks much.

@fmbenhassine
Copy link
Contributor

@Buzzardo Thank you for all these updates! I did a quick check and it looks ok now. Let's iterate on this. Could you please rebase the PR on the latest master branch? Thank you upfront.

@fmbenhassine fmbenhassine added in: documentation status: waiting-for-reporter Issues for which we are waiting for feedback from the reporter labels May 15, 2020
@fmbenhassine fmbenhassine added this to the 4.3.0 milestone May 15, 2020
Jay Bryant added 2 commits May 15, 2020 10:09
I edited the leader paragraphs above each code block that was flagged as being XML or Java content, such that the paragraphs make sense when both the XML and the Java blocks are present. I turned the Both button back on. I also caught a bunch of other editing things.
Mahmoud Ben Hassine caught a couple of sentences that were problematic when the Both option is on. I then caught a couple of other problems. I fixed all of that. Thanks for reading closely, Mahmoud. I always appreciate that.
@Buzzardo
Copy link
Author

@benas I have rebased and cleared up all the conflicts.

@fmbenhassine
Copy link
Contributor

Rebased, squashed and merged as efdce56. I did another check and noticed a couple of typos and rendering issues like:

Screenshot 2020-05-20 at 11 49 45

Screenshot 2020-05-20 at 12 06 00

which I fixed in ffd3908.

@Buzzardo Thank you very much for your PR!

@fmbenhassine fmbenhassine changed the title Made the "Both" option make sense Add flag to show both configuration styles (Java and XML) in reference docs May 20, 2020
@fmbenhassine fmbenhassine mentioned this pull request May 20, 2020
@fmbenhassine fmbenhassine removed the status: waiting-for-reporter Issues for which we are waiting for feedback from the reporter label May 20, 2020
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.

2 participants