Re: Generating + formatting the Board report from the website?
On Wed, May 22, 2019 at 10:26 AM Justin Mclean wrote: > > Hi, > > > Doesn't the new Markdown format help with that? > > I hope it will but: > a) Messy markdown with inconsistent formatting can still look good. > b) Some podlings submit at the last minutes and ignore formatting. > c) Some podlings tend to copy and paste the last report and modify and may > miss/alter the markdown. > > We’ll see what happens. > > > Most of my sloppy formatting is already fixed by the Markdown > > conversion > > I'm not sure the board will be viewing the results of the markdown but just > the raw text??? Currently the Whimsy report tool doesn’t support markdown > right? Let's back up, and ignore whimsy for the moment. Approved board minutes are published here, in text/plain format: https://www.apache.org/foundation/board/calendar.html We need to figuring out what the desired end result (currently I believe that this is spec'ed someplace as less than 80 characters per line and no wiki markup, but I forget where), and then work backwards to figure out when these changes are to be mad. It is entirely possible that all of these changes can be made without whimsy. - Sam Ruby - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
On Wed, May 22, 2019 at 4:27 PM Justin Mclean wrote: > ...I'm not sure the board will be viewing the results of the markdown but > just the raw text???... I think you need plaintext for the Board report but my idea was to get that by copying and pasting the output of the Markdown conversion: -Select and copy the report from https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 to your clipboard -Paste that into a text file -Run fold -s -w76 | cat -s on that Including the Markdown conversion in the pipeline cleans up quite a number of things already, even if the end result is plain text. -Bertrand - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > Doesn't the new Markdown format help with that? I hope it will but: a) Messy markdown with inconsistent formatting can still look good. b) Some podlings submit at the last minutes and ignore formatting. c) Some podlings tend to copy and paste the last report and modify and may miss/alter the markdown. We’ll see what happens. > Most of my sloppy formatting is already fixed by the Markdown > conversion I'm not sure the board will be viewing the results of the markdown but just the raw text??? Currently the Whimsy report tool doesn’t support markdown right? Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, On Wed, May 22, 2019 at 3:19 PM Justin Mclean wrote: > ...Reflow so that they are human readable is a little hard to write down. :-) > Mostly it because of the wide > variation of formatting podlings submit their reports ... Doesn't the new Markdown format help with that? I experimented a bit at https://cwiki.apache.org/confluence/display/INCUBATOR/June2019#testing-the-formatting and the problems in my input are immediately visible in the preview or after you save - so people will hopefully pay more attention now that they see the (first stage) conversion. Most of my sloppy formatting is already fixed by the Markdown conversion (assuming you copy the result from the https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 output) and the remaining problems are obvious. And for a second stage "fold -s -w76 | cat -s" (or the equivalent in Whimsy) might be sufficient ? -Bertrand - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > The duplication problem was fixed by changing the incubator report to > not have lines starting with dashes surrounding the TOC. I’m not 100% sure it fixed, as it happened again after that. It’s happened 4 or 5 times from memory, each time it need to be fixed manually. > There actually is special case logic, including tests, for reflowing > incubator reports. Here are the tests: > > https://github.com/apache/whimsy/blob/master/www/board/agenda/spec/reflow_spec.rb I’m not familiar with Ruby so that doesn’t mean a lot to me. > What we haven't had is someone write down the rules for reflowing > incubator reports. Reflow so that they are human readable is a little hard to write down. :-) Mostly it because of the wide variation of formatting podlings submit their reports in. For instance one podling last month neglected to use newlines and was a solid block of text. I’m not sure we could easily auto-fix that. Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
On Wed, May 22, 2019 at 8:28 AM Justin Mclean wrote: > > Hi, > > > - Whimsy likes 80 column linewraps. It will only rewrap the current > > report if you push the rewrap button and then commit. It doesn't ever > > wrap long URLs. > > Currently that severely breaks the incubator report so I don’t use it. Also > any edits to the incubator report in Whimsey duplicates large sections of it. > Both of these issues are known. The duplication problem was fixed by changing the incubator report to not have lines starting with dashes surrounding the TOC. There actually is special case logic, including tests, for reflowing incubator reports. Here are the tests: https://github.com/apache/whimsy/blob/master/www/board/agenda/spec/reflow_spec.rb What we haven't had is someone write down the rules for reflowing incubator reports. If that were done, you might be able to save a good fraction of that half hour a month of effort. > Thanks, > Justin - Sam Ruby - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > - Whimsy likes 80 column linewraps. It will only rewrap the current > report if you push the rewrap button and then commit. It doesn't ever > wrap long URLs. Currently that severely breaks the incubator report so I don’t use it. Also any edits to the incubator report in Whimsey duplicates large sections of it. Both of these issues are known. Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Bertrand Delacretaz wrote on 5/22/19 6:09 AM: > On Wed, May 22, 2019 at 11:46 AM Justin Mclean > wrote: >> ...It’s still unclear to me how Whimsy will render this, guess we find out >> when we submit it?.. > > I think the core of the Board agenda is the text file in svn, that's > what needs to be clean AFAIK. Yup - the entire board agenda is in SVN; you can either hand-edit, or use Whimsy to post/edit a single report at a time. Whimsy has logic about what buttons are presented to take actions, but the end result of Whimsy actions is to simply checkin that change to the SVN file. Key Whimsy takeaways: - Never allow a line of exactly 41 '-' dash characters in your report, because Whimsy uses that as an attachment (report) separator. See code: https://issues.apache.org/jira/browse/WHIMSY-265?page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel=16845155#comment-16845155 - Whimsy likes 80 column linewraps. It will only rewrap the current report if you push the rewrap button and then commit. It doesn't ever wrap long URLs. The linebreak/wrap logic code is here: https://github.com/apache/whimsy/blob/7e00fb38fec3437635b531751cbc1c4644e4bd41/www/board/agenda/views/pages/report.js.rb#L103 - As a UI display feature *only*: Whimsy attempts to display with a yellow highlight any lines that it thinks are too long. This yellow highlight is only a UI artifact, and does not change any data. -- - Shane Whimsy PMC The Apache Software Foundation - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > I think the core of the Board agenda is the text file in svn, that's > what needs to be clean AFAIK. Yep and IMO a little bit of markdown in that doesn’t make it any harder to read. Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, On Wed, May 22, 2019 at 11:46 AM Justin Mclean wrote: > ...It’s still unclear to me how Whimsy will render this, guess we find out > when we submit it?.. I think the core of the Board agenda is the text file in svn, that's what needs to be clean AFAIK. -Bertrand - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > Perhaps next time, save the before and after and the whimsy team can > take a look at how much of it can be automated. It’s all in versions so that easy to do. IMO Some could possible be automated, somethings are going to be very hard to do so as it would need to selectively join or split or indent lines. Podlings sometime make a right mess of the formatting Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
On Wed, May 22, 2019 at 5:46 AM Justin Mclean wrote: > > Hi, > > > Do you then mean to run "fold -w 76 cat -s" on the formatted Markdown > > to prepare it for the Board report? > > Yes, as your experiment is still of use. Someone somewhere is still going to > view it in text form. > > It’s still unclear to me how Whimsy will render this, guess we find out when > we submit it? > > > That seems to work fine as the basic formatting is now clean. > > Going on precious experience I still expect to be a fair amount of hand > editing after that to fix things. It usually takes an hour of my time. Perhaps next time, save the before and after and the whimsy team can take a look at how much of it can be automated. > Thanks, > Justin - Sam Ruby - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > Do you then mean to run "fold -w 76 cat -s" on the formatted Markdown > to prepare it for the Board report? Yes, as your experiment is still of use. Someone somewhere is still going to view it in text form. It’s still unclear to me how Whimsy will render this, guess we find out when we submit it? > That seems to work fine as the basic formatting is now clean. Going on precious experience I still expect to be a fair amount of hand editing after that to fix things. It usually takes an hour of my time. Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
On Wed, May 22, 2019 at 10:18 AM Justin Mclean wrote: > ...So INFRA kindly installed a markdown macro for confluence so you can now > see > the incubator report with some formatting when you edit it. [1].. Cool! I have removed my formatting experiment, https://github.com/apache/incubator/commit/71701e0ee Do you then mean to run "fold -w 76 cat -s" on the formatted Markdown to prepare it for the Board report? That seems to work fine as the basic formatting is now clean. -Bertrand > [1] https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, So INFRA kindly installed a markdown macro for confluence so you can now see the incubator report with some formatting when you edit it. [1] Thanks, Justin 1. https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > Please remove Dubbo since it graduated. Will do, the data it auto generated as you know, the podling.xml file hadn’t been updated when it was generated (or the graduation announced). Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi Justin, Please remove Dubbo since it graduated. Regards, Dave Sent from my iPhone > On May 21, 2019, at 4:57 PM, Dave Fisher wrote: > > Hi Justin, > > You gave me four to shepherd again and missed Drew. > > Thanks, > Dave > >> On May 21, 2019, at 4:49 PM, Justin Mclean wrote: >> >> Hi, >> >> It been suggested we use markdown for the incubator reports. I modified the >> this months report [1] to have: >> - a table of contents >> - headings >> - checkboxes >> >> Is there anything else you basic format needd? >> >> Thanks, >> Justin >> >> 1. https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 >> - >> To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org >> For additional commands, e-mail: general-h...@incubator.apache.org >> > > > - > To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org > For additional commands, e-mail: general-h...@incubator.apache.org > - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, I also asked for a mark-down plug tube installed in confluence so podlings can see / preview their edits. https://issues.apache.org/jira/browse/INFRA-18439 Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > - checkboxes Seems that here are not standard markdown but supported by github’s (and a couple of other places) markdown. So not sure how useful that will be. Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi Justin, You gave me four to shepherd again and missed Drew. Thanks, Dave > On May 21, 2019, at 4:49 PM, Justin Mclean wrote: > > Hi, > > It been suggested we use markdown for the incubator reports. I modified the > this months report [1] to have: > - a table of contents > - headings > - checkboxes > > Is there anything else you basic format needd? > > Thanks, > Justin > > 1. https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 > - > To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org > For additional commands, e-mail: general-h...@incubator.apache.org > - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, It been suggested we use markdown for the incubator reports. I modified the this months report [1] to have: - a table of contents - headings - checkboxes Is there anything else you basic format needd? Thanks, Justin 1. https://cwiki.apache.org/confluence/display/INCUBATOR/June2019 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi， Justin，Thanks for your suggestion I will keep in mind for next report. Thanks 在 2019/5/20 下午6:55，“Justin Mclean” 写入: Hi, Some issues I see with the format: This: Three most important issues to address in the move towards graduation: 1. We begin to prepare an apache release, including prepare for unified License/Copyright, clean dependencies. 2. We depend on npsr’ time, it is MPL/LGPL license, we need to find another lib for it. Needs to be formatted like so: Three most important issues to address in the move towards graduation: 1. We begin to prepare an apache release, including prepare for unified License/Copyright, clean dependencies. 2. We depend on npsr’ time, it is MPL/LGPL license, we need to find another lib for it. Or similar each line needs to be indented by least two spaces. This is also OK. Three most important issues to address in the move towards graduation: 1. We begin to prepare an apache release, including prepare for unified License/Copyright, clean dependencies. 2. We depend on npsr’ time, it is MPL/LGPL license, we need to find another lib for it. Same with: Von Gosling: brpc community should pay more warm in the community building except the first release. Neds to be: Von Gosling: brpc community should pay more warm in the community building except the first release. Also this: On master, 253 files have changed and there have been 14,050 additions and 3,027 deletions. This: On master, 253 files have changed and there have been 14,050 additions and 3,027 deletions. I think you get the idea :-) Thanks, Justin
Re: Generating + formatting the Board report from the website?
Justin Mclean wrote on 5/20/19 9:04 AM: ...snip...>> Or we can improve the script or maybe even move to Markdown for the >> input to have more control, if you think this would help. > > Markdown might help the board in reviews (but not 100% sure about that), but > it would be more work for the podlings and some may be reluctant about this > imposition placed upon them. It does sort of seem a all or nothing sort of > scenario? Even if the report template contained markdown it can also be quite > easy to break. From memory it doesn’t support bare links which could be an > issue? (Although Asciidoctor does.) Markdown certainly allows bare links, although I suppose depending on the rendering engine they might or might not be clickable - which isn't really that important in our case IMO. For an example of what Whimsy tooling already supports for free (outputting either text or markdown from plaintext source data): https://whimsy.apache.org/roster/orgchart/ (try vp-brand or secretary) I agree the first step is figuring out how the IPMC can improve their process and the end result of the report, since that's the biggest userbase to make changes with. Then we can focus on what would be easy - and pretty - for the board to consume. Thanks for the ideas and progress! -- - Shane Director & Member The Apache Software Foundation - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, > It doesn't look too bad to me - my point would be that if people can > see the final formatted result at that URL they can fix their reports. > themselves (like for the example you give below) and you don't have to > do that. I'm all for something that encourages podlings to correctly format the report themselves. As long as we can get them to use the tool that is :-) > Or we can improve the script or maybe even move to Markdown for the > input to have more control, if you think this would help. Markdown might help the board in reviews (but not 100% sure about that), but it would be more work for the podlings and some may be reluctant about this imposition placed upon them. It does sort of seem a all or nothing sort of scenario? Even if the report template contained markdown it can also be quite easy to break. From memory it doesn’t support bare links which could be an issue? (Although Asciidoctor does.) Thanks, Justin - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi Justin, I've put your test content in and added cat -s, the formatted result is at http://incubator.apache.org/report.html It doesn't look too bad to me - my point would be that if people can see the final formatted result at that URL they can fix their reports themselves (like for the example you give below) and you don't have to do that. Whereas using the wiki IIUC people don't see the final result and if anyone runs an automatic reformat things might break. Or we can improve the script or maybe even move to Markdown for the input to have more control, if you think this would help. -Bertrand On Mon, May 20, 2019 at 12:56 PM Justin Mclean wrote: > ...Also this: > On master, 253 files have changed and there have been 14,050 additions > and > 3,027 deletions. > This: > On master, 253 files have changed and there have been 14,050 additions > and 3,027 deletions. - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, Or perhaps another way of looking at it, is that given I already do this (and hand edit): fold -w 76 -s $1 | cat -s You can probably skip that step for the final report, but then I’m not sure what this result gives over the existing confluence page. [1] Unless you have something more in mind? Thanks, Justin 1. https://cwiki.apache.org/confluence/display/INCUBATOR/May2019 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
Re: Generating + formatting the Board report from the website?
Hi, Some issues I see with the format: This: Three most important issues to address in the move towards graduation: 1. We begin to prepare an apache release, including prepare for unified License/Copyright, clean dependencies. 2. We depend on npsr’ time, it is MPL/LGPL license, we need to find another lib for it. Needs to be formatted like so: Three most important issues to address in the move towards graduation: 1. We begin to prepare an apache release, including prepare for unified License/Copyright, clean dependencies. 2. We depend on npsr’ time, it is MPL/LGPL license, we need to find another lib for it. Or similar each line needs to be indented by least two spaces. This is also OK. Three most important issues to address in the move towards graduation: 1. We begin to prepare an apache release, including prepare for unified License/Copyright, clean dependencies. 2. We depend on npsr’ time, it is MPL/LGPL license, we need to find another lib for it. Same with: Von Gosling: brpc community should pay more warm in the community building except the first release. Neds to be: Von Gosling: brpc community should pay more warm in the community building except the first release. Also this: On master, 253 files have changed and there have been 14,050 additions and 3,027 deletions. This: On master, 253 files have changed and there have been 14,050 additions and 3,027 deletions. I think you get the idea :-) Thanks, Justin
Re: Generating + formatting the Board report from the website?
Hi,
The "fold -s -w 76" will breaks on long line e.g URLs. I do something similar
and need to manually fix that, I’d also add "| cat -s” to tame extra blank
lines.
Not to dampen your enthusiasm, but their one huge assumption here and that’s
you usually taken the result of what was hand edited, so while it may make it
easier to review it still just as much work.
Try using this content [1] instead or another in history from before I did
clean up on it. It might be better taking one from the same point in history
from the old wiki and see what the results are. Confluence manages to stuff up
teh whitespace, before I release the solution to that was a {noformat} block.
Thanks,
Justin
1. https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=113709394
-
To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org
For additional commands, e-mail: general-h...@incubator.apache.org
Generating + formatting the Board report from the website?
Hi, It seems like there was some trouble and manual work to generate the Board report since switching to https://cwiki.apache.org/incubator As an experiment that should make this easier, I have created a small pipeline that starts from a text file in Git [1], uses a script to sanitize that file [2] and publishes the result at [3], an HTML page that includes the report in a block. Thanks to Dave's great work in making publishing fast, it only takes about a minute from changing [1] to seeing the results at [3]. The idea is that people would edit the former and use the latter to verify that the formatting and sanitizing didn't break their report. And no more formatting work for the PMC chair, the report should be automatically good to go - and if not the preprocessing script can be tweaked to achieve that. WDYT? If we don't like this or find a better solution it's a single commit to revert, [4] -Bertrand [1] https://github.com/apache/incubator/blob/master/report.txt [2] https://github.com/apache/incubator/blob/master/preprocess_content.sh [3] http://incubator.apache.org/report.html [4] https://github.com/apache/incubator/commit/33ecf33 - To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
