Skip to content

README as fragments#71

Merged
pedrobaeza merged 4 commits into
OCA:11.0from
acsone:new-readme-sbi
May 25, 2018
Merged

README as fragments#71
pedrobaeza merged 4 commits into
OCA:11.0from
acsone:new-readme-sbi

Conversation

@sbidoul
Copy link
Copy Markdown
Member

@sbidoul sbidoul commented May 25, 2018

Since the README had a minor glitch that blocked the pypi upload I take the opportunity to convert it to fragments.

More important (to be reviewed):

@sbidoul sbidoul requested a review from guewen May 25, 2018 06:20
Copy link
Copy Markdown

@elicoidal elicoidal left a comment

Choose a reason for hiding this comment

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

LGTM

@simahawk
Copy link
Copy Markdown
Contributor

@sbidoul final result seems weird, at least here on GH:

image

@simahawk
Copy link
Copy Markdown
Contributor

also, travis is red :)

@sbidoul
Copy link
Copy Markdown
Member Author

sbidoul commented May 25, 2018

final result seems weird

I indeed noticed the TOC bullet list does not look nice when DESCRIPTION.rst itself ends with a bullet list.

I'll add a bold Table of contents line in the template as a separator.

Travis is going to be just fine. For some reason it attempted to build a wrong branch.

@sbidoul
Copy link
Copy Markdown
Member Author

sbidoul commented May 25, 2018

@simahawk if you have any other comment on the overall readme structure, shoot now :)

@sbidoul
Copy link
Copy Markdown
Member Author

sbidoul commented May 25, 2018

Updated. See also OCA/maintainer-tools#343

@pedrobaeza
Copy link
Copy Markdown
Member

About this, AFAIK @lmignon is also an active maintainer, isn't it?

@guewen
Copy link
Copy Markdown
Member

guewen commented May 25, 2018

Very nice, thanks!

development_status = Mature

So I created #72 to be in line with the requirements :)

@pedrobaeza
Copy link
Copy Markdown
Member

Waiting for my question about maintainers before merging.

@sbidoul
Copy link
Copy Markdown
Member Author

sbidoul commented May 25, 2018

@pedrobaeza it's obvious that guewen has the maintainer role here, that's why I proposed it as a way to kickstart the process of adding maintainers somewhere. If @guewen wants help and @lmignon wants to do it I'm fine with that of course, but that is up to them to coordinate and propose, as described in the maintainer role document.


(...)
[queue_job]
channels = root:4
Copy link
Copy Markdown
Member

@guewen guewen May 25, 2018

Choose a reason for hiding this comment

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

That's out of scope and not new, but the basic configuration shown here can block all the HTTP workers. I think we should put channels = root:2 or put more HTTP workers. (I can do it in a subsequent PR)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Then it's good to change this at the same time I think

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes the queue_job documentation needs some love. I did not touch the content here.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

BTW with workers = 4 it would even be root:1, because one wkhtmlpdf report needs 2 workers so we need at least 3 free to generate a report and keep the UI working while the report runs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Right. I propose to merge this PR without any changes to the content.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

OK, merging now and waiting for later PRs for these considerations.

@pedrobaeza
Copy link
Copy Markdown
Member

@sbidoul OK, I though this was the case for a shared maintainer role (and more as this module is huge).

Copy link
Copy Markdown
Contributor

@lmignon lmignon left a comment

Choose a reason for hiding this comment

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

Great!!!
@pedrobaeza I consider myself as a contributor and reviewer. Guewen is the maintainer.

@pedrobaeza pedrobaeza merged commit c9b5158 into OCA:11.0 May 25, 2018
@sbidoul
Copy link
Copy Markdown
Member Author

sbidoul commented May 25, 2018

BTW I prefer to have many maintainers very active on few modules each, rather than few maintainers risking burnout on many modules. We'll need to launch a campaign to have maintainers declare themselves.

@sbidoul sbidoul deleted the new-readme-sbi branch May 25, 2018 11:47
@pedrobaeza
Copy link
Copy Markdown
Member

@sbidoul OK, let's try! On the code sprint we can also make a scan over repositories for this.

@sbidoul
Copy link
Copy Markdown
Member Author

sbidoul commented May 25, 2018

Oops, forgot CONTRIBUTORS.rst, added at 0a9a13d

@coveralls
Copy link
Copy Markdown

coveralls commented May 25, 2018

Coverage Status

Coverage remained the same at 77.675% when pulling baa8702 on acsone:new-readme-sbi into abc3d2f on OCA:11.0.

guewen pushed a commit to guewen/queue that referenced this pull request May 29, 2018
guewen pushed a commit to guewen/queue that referenced this pull request May 29, 2018
guewen pushed a commit to guewen/queue that referenced this pull request May 29, 2018
guewen pushed a commit to guewen/queue that referenced this pull request May 29, 2018
pedrobaeza added a commit that referenced this pull request May 31, 2018
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.

7 participants