You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@training.apache.org by Christofer Dutz <ch...@c-ware.de> on 2019/04/26 10:53:51 UTC
New Reveal.JS Presentation Template
Hi all,
I just wanted to tell you that as I needed a second module to test the build stuff, I finally cleaned up my template, scrubbed my corporate branding and committed that into the “tools/maven-revealjs-asciidoctor-templte”
It’s built with Maven and should do most out of the box. However in the examples, I have a few special goodies that need some setup on your side. So If you see some ugly looking stuff where you are expecting charts, you’re probably missing something. In the template folder I did write up how to setup things and it contains a script I used to install my third party stuff … but not sure it works on every machine. I guess this will be something we should work on together.
When updating to the latest Asciidoctor 2 it seems the output changed, that now a index.revealjs and no longer index.html … have to find out why that’s the case.
You could directly open the file in a browser and most of Reveal.JS would work, however some of the JavaScript in the Speaker View doesn’t work in that case (Timers, Resetting the timers, …) If you don’t need that, you can simply open the index.revealjs in a browser.
Ok … now I’m gonna duck and cover because I know there will be “oppinions” ;-)
Have fun and a great weekend.
Chris
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
Having done my first review in ages I have to agree. I find the Github PR
review stuff super confusing. I actually saw comments in mails that I had
trouble finding online.
> but is there any reason we’re not just using git instead relying ...
@Justin: I don't quite understand what you're proposing instead, though?
@Chris: Are you talking only about the mails? I'm confused ;-)
On Tue, Apr 30, 2019 at 12:33 PM Christofer Dutz <ch...@c-ware.de>
wrote:
> I'll give a big fat +1 to this ...
>
> Especially as I can never see what the change is about as all I can see in
> my mail client is
> that it's coming from github and a comment to a PR was added ;-)
> So I usually simply delete all of these emails.
>
> Chris
>
>
> Am 30.04.19, 11:49 schrieb "Justin Mclean" <ju...@classsoftware.com>:
>
> Hi,
>
> As an aside, I have to say I'm really disliking using GitHub PRs (and
> process) for making changes to PRs. Call me old fashioned, but is there any
> reason we’re not just using git instead relying on features that require
> you to use Github website?
>
> Thanks,
> Justin
>
>
Re: New Reveal.JS Presentation Template
Posted by Christofer Dutz <ch...@c-ware.de>.
I'll give a big fat +1 to this ...
Especially as I can never see what the change is about as all I can see in my mail client is
that it's coming from github and a comment to a PR was added ;-)
So I usually simply delete all of these emails.
Chris
Am 30.04.19, 11:49 schrieb "Justin Mclean" <ju...@classsoftware.com>:
Hi,
As an aside, I have to say I'm really disliking using GitHub PRs (and process) for making changes to PRs. Call me old fashioned, but is there any reason we’re not just using git instead relying on features that require you to use Github website?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
As an aside, I have to say I'm really disliking using GitHub PRs (and process) for making changes to PRs. Call me old fashioned, but is there any reason we’re not just using git instead relying on features that require you to use Github website?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> It'd be great if we could have the CSS in some "common" directory so not
> everything repeats the basic stuff.
My CSS is a little different to Chris’s but I guess I could extra the differences and only include that.
> Yes, this is super annoying! Also...it creates a WAR file? There's also
> commented out stuff in the pom etc.
The War file is needed if you want to run via a server. In my case it seem fine to run locally so I’m not 100% sure what features needed that.
> The install-deps.sh is for MacOS only and has no documentation, is it
> really needed? What for?
I needed to run it (and a few other commands) to get everything installed.
> I'm in favor of making it anonymous, yes. A similar reason to the @author
> tags. This information is prone to go stale as more people contribute to it.
OK.
> Well, this is my vision and nothing more: Yes, it's in the right place,
> mostly. But it shouldn't contain the pom.xml and reveal stuff (template,
> css).
Those are likely to be different per presentation.
> In my mind we'd have a "content" repository in the "content" folder
> (including asciidoc, jpg, mp4 files etc.)
Perhaps I’m missing something but that's in src/main
> and then assemble that with yet to be designed tools (or shell scripts) in the "sessions" folder which
> would hopefully allow us to reuse css and other things.
Ah so you want me to submit a compiled / working version of the output as well?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
As you might have seen I went ahead and created a Jira account and two
subscriptions. They are set up to send a weekly reminder every Friday
morning (UTC) but I don't have a particular opinion about the time/date, so
happy to change it to some other date.
On Fri, May 10, 2019 at 10:01 AM Lars Francke <la...@gmail.com>
wrote:
> As a follow-up: I think it'd be great if we could get a weekly reminder
> mail sent to dev@ for all Jiras that still need triaging or a open for
> review as well as pull requests that are open.
>
> Also: Did we decide to have a Jira for pull requests or not? I find it
> very confusing to have it split across two systems.
>
> On Fri, May 10, 2019 at 9:56 AM Lars Francke <la...@gmail.com>
> wrote:
>
>> I believe it to be just normal that things take a while to establish
>> themselves. This is a brand new project which didn't exist before, that
>> makes it different from most other projects that enter incubation where
>> established teams are already used to this. People (me included) need to
>> find "new" time for this project and that's not always easy :)
>>
>> That doesn't take away any of the appreciation I have for the work you or
>> others are doing! I'm sorry it's taking so long and I hope we'll get around
>> to it soon.
>>
>> Cheers,
>> Lars
>>
>> On Fri, May 10, 2019 at 7:29 AM Justin Mclean <ju...@classsoftware.com>
>> wrote:
>>
>>> Hi,
>>>
>>> Ping anyone? Perhaps it would be better to move to a CTR workflow, if
>>> people are not available to review things?
>>>
>>> Thanks,
>>> Justin
>>
>>
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
As a follow-up: I think it'd be great if we could get a weekly reminder
mail sent to dev@ for all Jiras that still need triaging or a open for
review as well as pull requests that are open.
Also: Did we decide to have a Jira for pull requests or not? I find it very
confusing to have it split across two systems.
On Fri, May 10, 2019 at 9:56 AM Lars Francke <la...@gmail.com> wrote:
> I believe it to be just normal that things take a while to establish
> themselves. This is a brand new project which didn't exist before, that
> makes it different from most other projects that enter incubation where
> established teams are already used to this. People (me included) need to
> find "new" time for this project and that's not always easy :)
>
> That doesn't take away any of the appreciation I have for the work you or
> others are doing! I'm sorry it's taking so long and I hope we'll get around
> to it soon.
>
> Cheers,
> Lars
>
> On Fri, May 10, 2019 at 7:29 AM Justin Mclean <ju...@classsoftware.com>
> wrote:
>
>> Hi,
>>
>> Ping anyone? Perhaps it would be better to move to a CTR workflow, if
>> people are not available to review things?
>>
>> Thanks,
>> Justin
>
>
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
On Fri, May 10, 2019 at 10:32 AM Lars Francke <la...@gmail.com>
wrote:
>
>
> On Fri, May 10, 2019 at 10:23 AM Justin Mclean <ju...@me.com>
> wrote:
>
>> Hi,
>>
>> > I believe it to be just normal that things take a while to establish
>> themselves.
>>
>> I first made that pull request 2 weeks ago, that seems a long time to get
>> something into a repo. But then again all ASF projects I work on use CTR,
>> where any committer can commit right away, and others can review when they
>> need and/or when coming up to a release, rather than the process here.
>>
>
> I understand the frustration (I actually gave a whole talk on it), in
> other projects I have to wait for months or years to get something
> committed :(
>
> I've seen in so many projects (not going to name names here but I've
> discussed it on the relevant project lists at the time) where the reviews
> just never happen. "We'll get to it later", "Yes, we still need to fix it",
> "We'll just create a follow-up Jira" etc. but it never happens. It also
> puts the burden of getting the quality right on someone else and allows
> anyone to commit any quality (obviously not implying anything about the
> quality of stuff you've contributed so far). This - in my personal opinion
> - is very bad and comes from my experience. I'm happy to hear that your
> experience with CTR has been more positive though!
>
>
>> I’m sort of a little confused to why we need to have two people(?) need
>> to approve a PR before it get submitted, IMO that stops people being able
>> to work effectively on it and collaborate and seems to just prolong the
>> process. This process also seem to enforce use of the GitHub UI which if at
>> all possible I’d rather avoid. I go along with it if I must but I really
>> not sure what advantage it gives over having a discussion here on the
>> mailing list. It seems to fragment the discussion and people not following
>> along on GitHub may be missing context.
>>
>
> Two people? I think we agreed that only a single +1 is needed. Dmitry
> asked the same recently. So whoever does the review can also commit. I also
> don't see why you have to use the Github interface. You can just attach a
> patch to Jira.
>
As a follow-up: Sönke wanted to write the contributors guide based on the
guidelines we voted on. I hope he gets to it soon :)
>
>
>> I appreciated the feedback given on the PRs but so far it seems that the
>> PR needs to be of a very high standard before it can be committed. My
>> concern is that may be an artificial barrier to entry, especially when
>> starting out. IMO It good to have a few things not 100% polished in your
>> repo as that give people work to do if they are inclined.
>
>
> I think my earlier comment relates to this. Looking at the current and
> past contributions I don't think anyone has really been blocked by
> unreasonable requests/high standard only by a lack of time.
>
>
>> Thanks,
>> Justin
>>
>>
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
Another thing I just remembered:
We even added this provision in the contribution guidelines of being able
to commit stuff at your own discretion when you asked for a review and no
one gets around to it.
We really need to get the website up!
On Fri, May 10, 2019, 11:03 Justin Mclean <ju...@classsoftware.com> wrote:
> Hi,
>
> > This - in my personal opinion - is very bad and comes from my
> experience. I'm happy to hear that your
> > experience with CTR has been more positive though!
>
> I have also seen where CTR doesn’t work so well and that was with with a
> complex tightly coupled code based.
>
> This project is not that :-)
>
> > I also don’t see why you have to use the Github interface. You can just
> attach a patch
> > to Jira.
>
> I’ll do that in future, but that’s probably going to be less visible than
> a PR.
>
> > I think my earlier comment relates to this. Looking at the current and
> past
> > contributions I don't think anyone has really been blocked by
> unreasonable
> > requests/high standard only by a lack of time.
>
> Fair enough.
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> This - in my personal opinion - is very bad and comes from my experience. I'm happy to hear that your
> experience with CTR has been more positive though!
I have also seen where CTR doesn’t work so well and that was with with a complex tightly coupled code based.
This project is not that :-)
> I also don’t see why you have to use the Github interface. You can just attach a patch
> to Jira.
I’ll do that in future, but that’s probably going to be less visible than a PR.
> I think my earlier comment relates to this. Looking at the current and past
> contributions I don't think anyone has really been blocked by unreasonable
> requests/high standard only by a lack of time.
Fair enough.
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
On Fri, May 10, 2019 at 10:23 AM Justin Mclean <ju...@me.com> wrote:
> Hi,
>
> > I believe it to be just normal that things take a while to establish
> themselves.
>
> I first made that pull request 2 weeks ago, that seems a long time to get
> something into a repo. But then again all ASF projects I work on use CTR,
> where any committer can commit right away, and others can review when they
> need and/or when coming up to a release, rather than the process here.
>
I understand the frustration (I actually gave a whole talk on it), in other
projects I have to wait for months or years to get something committed :(
I've seen in so many projects (not going to name names here but I've
discussed it on the relevant project lists at the time) where the reviews
just never happen. "We'll get to it later", "Yes, we still need to fix it",
"We'll just create a follow-up Jira" etc. but it never happens. It also
puts the burden of getting the quality right on someone else and allows
anyone to commit any quality (obviously not implying anything about the
quality of stuff you've contributed so far). This - in my personal opinion
- is very bad and comes from my experience. I'm happy to hear that your
experience with CTR has been more positive though!
> I’m sort of a little confused to why we need to have two people(?) need to
> approve a PR before it get submitted, IMO that stops people being able to
> work effectively on it and collaborate and seems to just prolong the
> process. This process also seem to enforce use of the GitHub UI which if at
> all possible I’d rather avoid. I go along with it if I must but I really
> not sure what advantage it gives over having a discussion here on the
> mailing list. It seems to fragment the discussion and people not following
> along on GitHub may be missing context.
>
Two people? I think we agreed that only a single +1 is needed. Dmitry asked
the same recently. So whoever does the review can also commit. I also don't
see why you have to use the Github interface. You can just attach a patch
to Jira.
> I appreciated the feedback given on the PRs but so far it seems that the
> PR needs to be of a very high standard before it can be committed. My
> concern is that may be an artificial barrier to entry, especially when
> starting out. IMO It good to have a few things not 100% polished in your
> repo as that give people work to do if they are inclined.
I think my earlier comment relates to this. Looking at the current and past
contributions I don't think anyone has really been blocked by unreasonable
requests/high standard only by a lack of time.
> Thanks,
> Justin
>
>
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@me.com>.
Hi,
> I believe it to be just normal that things take a while to establish themselves.
I first made that pull request 2 weeks ago, that seems a long time to get something into a repo. But then again all ASF projects I work on use CTR, where any committer can commit right away, and others can review when they need and/or when coming up to a release, rather than the process here.
I’m sort of a little confused to why we need to have two people(?) need to approve a PR before it get submitted, IMO that stops people being able to work effectively on it and collaborate and seems to just prolong the process. This process also seem to enforce use of the GitHub UI which if at all possible I’d rather avoid. I go along with it if I must but I really not sure what advantage it gives over having a discussion here on the mailing list. It seems to fragment the discussion and people not following along on GitHub may be missing context.
I appreciated the feedback given on the PRs but so far it seems that the PR needs to be of a very high standard before it can be committed. My concern is that may be an artificial barrier to entry, especially when starting out. IMO It good to have a few things not 100% polished in your repo as that give people work to do if they are inclined.
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
I believe it to be just normal that things take a while to establish
themselves. This is a brand new project which didn't exist before, that
makes it different from most other projects that enter incubation where
established teams are already used to this. People (me included) need to
find "new" time for this project and that's not always easy :)
That doesn't take away any of the appreciation I have for the work you or
others are doing! I'm sorry it's taking so long and I hope we'll get around
to it soon.
Cheers,
Lars
On Fri, May 10, 2019 at 7:29 AM Justin Mclean <ju...@classsoftware.com>
wrote:
> Hi,
>
> Ping anyone? Perhaps it would be better to move to a CTR workflow, if
> people are not available to review things?
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
Ping anyone? Perhaps it would be better to move to a CTR workflow, if people are not available to review things?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
Hi,
I haven't had time to look again but it's on my list. Maybe someone else
gets to it before then?
Sorry,
Lars
On Tue, May 7, 2019 at 5:24 AM Justin Mclean <ju...@classsoftware.com>
wrote:
> Hi,
> So what needs to be done to get this committed?
> Thanks,
> Justin
>
> On Wed, 1 May 2019, 14:21 Justin Mclean, <ju...@classsoftware.com> wrote:
>
> > Hi,
> >
> > So I just added a script to auto generate some of the stats in the slides
> > from Apache Whimsy JSON file. Would be easy to alter to generally update
> > stats for a project or podling about page. I guess it could be done via
> JS
> > in the pages itself but that seemed a but too much as I don’t really
> need a
> > live count of committers :-)
> >
> > Perhaps generating a slide deck with an about page of each project /
> > podling might be useful to people? Even if only as an example how this
> sort
> > of tooling can work / attract more people here?
> >
> > Thanks,
> > Justin
>
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
So what needs to be done to get this committed?
Thanks,
Justin
On Wed, 1 May 2019, 14:21 Justin Mclean, <ju...@classsoftware.com> wrote:
> Hi,
>
> So I just added a script to auto generate some of the stats in the slides
> from Apache Whimsy JSON file. Would be easy to alter to generally update
> stats for a project or podling about page. I guess it could be done via JS
> in the pages itself but that seemed a but too much as I don’t really need a
> live count of committers :-)
>
> Perhaps generating a slide deck with an about page of each project /
> podling might be useful to people? Even if only as an example how this sort
> of tooling can work / attract more people here?
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
So I just added a script to auto generate some of the stats in the slides from Apache Whimsy JSON file. Would be easy to alter to generally update stats for a project or podling about page. I guess it could be done via JS in the pages itself but that seemed a but too much as I don’t really need a live count of committers :-)
Perhaps generating a slide deck with an about page of each project / podling might be useful to people? Even if only as an example how this sort of tooling can work / attract more people here?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Christofer Dutz <ch...@c-ware.de>.
Yeah, my last comment was regarding the automatic emails.
Chris
Outlook für Android<https://aka.ms/ghei36> herunterladen
________________________________
From: Lars Francke <la...@gmail.com>
Sent: Tuesday, April 30, 2019 5:07:26 PM
To: dev@training.apache.org
Subject: Re: New Reveal.JS Presentation Template
Hi Chris,
thank you. Sorry, I should have read the whole thread before commenting.
I'll try to look at your code in detail before saying more.
Cheers,
Lars
On Mon, Apr 29, 2019 at 11:17 PM Christofer Dutz <ch...@c-ware.de>
wrote:
> HI Lars,
>
> that the generator creates index.revealjs came in when updating to
> Asciidoctor 2.
> I am certain we can figure out why this happens and change it back to
> index.html. I don't see a huge issue with that.
>
> I generate a war as in order for all operations of the presentation to
> work, it needs to be loaded with http or https. When using "file", some
> JavaScript doesn't work.
> That's why I package it as war and run it with the jetty plugin.
>
> The presentation is runnable with:
>
> mvn package jetty:run-exploded
>
> I did mention that the install-deps is a script I wrote for myself on my
> Mac and that we need to adjust it to other platform.
> I have a lot of examples in the template that utilize different external
> tools. In order to work, they need to be installed.
> You don't need all of them, just the ones you need in your presentation.
>
> As I mentioned in my email before, I commented out the reference to the
> extensions lab which generates my diagrams as this
> didn't work after updating and I need to fix that before we can use it.
> But I remember people mentioning that they didn't like
> how those charts looked.
>
> Chris
>
> Am 29.04.19, 19:48 schrieb "Lars Francke" <la...@gmail.com>:
>
> Hi,
>
> I just added a review on Github and had a couple of comments which you
> mostly addressed here so I'll continue the conversation here. As we
> didn't
> have a review for Chris' stuff this is mostly not about what you added
> Justin but about the template itself.
>
> On Sat, Apr 27, 2019 at 9:01 AM Justin Mclean <
> justin@classsoftware.com>
> wrote:
>
> > Hi,
> >
> > So using Chris template I converted a set of my own slides and
> submitted a
> > PR with it.
> >
> > Some notes:
> > - Make sure you spell asciidoc directory correctly otherwise it will
> > compile but produce nothing :-)
> > - To have a slide with no title use “## !”.
> > - To have hard new lines use + at the end of line.
> > - Dark themes are good for screen but generally look poor on
> projectors,
> > modified the css to be black text on white and use a more common
> fonts with
> > fallbacks.
> >
>
> It'd be great if we could have the CSS in some "common" directory so
> not
> everything repeats the basic stuff.
>
>
> >
> > Al in all it was fairly easy to convert but there is a couple of
> rough
> > corners.
> > - Work out how to crop images and video so it the same as in the
> original
> > presentation.
> > - Footer is not showing for some unknown reason.
> > - Move titles to top of page rather than entering comment.
> > - Annoying to have to rename index.revealjs to index.html all the
> time.
> >
>
> Yes, this is super annoying! Also...it creates a WAR file? There's also
> commented out stuff in the pom etc.
> The install-deps.sh is for MacOS only and has no documentation, is it
> really needed? What for?
>
>
> > Questions:
> > - While there's no branding (other than the ASF) it does have my
> name on
> > it and a slide or two assumes I’m the person given it. Do we want to
> make
> > it more anonymous?
> >
>
> I'm in favor of making it anonymous, yes. A similar reason to the
> @author
> tags. This information is prone to go stale as more people contribute
> to it.
>
>
> > - Have I put it in the right place?
> > - What can we do to cut down on duplication? There's a few files I
> copies
> > and duplicated from Chris’s example.
> > - It builds on it own but not as part of the whole repo. Do we want
> to do
> > that?
> >
>
> Well, this is my vision and nothing more: Yes, it's in the right place,
> mostly. But it shouldn't contain the pom.xml and reveal stuff
> (template,
> css). In my mind we'd have a "content" repository in the "content"
> folder
> (including asciidoc, jpg, mp4 files etc.) and then assemble that with
> yet
> to be designed tools (or shell scripts) in the "sessions" folder which
> would hopefully allow us to reuse css and other things.
>
>
> >
> > Thanks,
> > Justin
>
>
>
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
Hi Chris,
thank you. Sorry, I should have read the whole thread before commenting.
I'll try to look at your code in detail before saying more.
Cheers,
Lars
On Mon, Apr 29, 2019 at 11:17 PM Christofer Dutz <ch...@c-ware.de>
wrote:
> HI Lars,
>
> that the generator creates index.revealjs came in when updating to
> Asciidoctor 2.
> I am certain we can figure out why this happens and change it back to
> index.html. I don't see a huge issue with that.
>
> I generate a war as in order for all operations of the presentation to
> work, it needs to be loaded with http or https. When using "file", some
> JavaScript doesn't work.
> That's why I package it as war and run it with the jetty plugin.
>
> The presentation is runnable with:
>
> mvn package jetty:run-exploded
>
> I did mention that the install-deps is a script I wrote for myself on my
> Mac and that we need to adjust it to other platform.
> I have a lot of examples in the template that utilize different external
> tools. In order to work, they need to be installed.
> You don't need all of them, just the ones you need in your presentation.
>
> As I mentioned in my email before, I commented out the reference to the
> extensions lab which generates my diagrams as this
> didn't work after updating and I need to fix that before we can use it.
> But I remember people mentioning that they didn't like
> how those charts looked.
>
> Chris
>
> Am 29.04.19, 19:48 schrieb "Lars Francke" <la...@gmail.com>:
>
> Hi,
>
> I just added a review on Github and had a couple of comments which you
> mostly addressed here so I'll continue the conversation here. As we
> didn't
> have a review for Chris' stuff this is mostly not about what you added
> Justin but about the template itself.
>
> On Sat, Apr 27, 2019 at 9:01 AM Justin Mclean <
> justin@classsoftware.com>
> wrote:
>
> > Hi,
> >
> > So using Chris template I converted a set of my own slides and
> submitted a
> > PR with it.
> >
> > Some notes:
> > - Make sure you spell asciidoc directory correctly otherwise it will
> > compile but produce nothing :-)
> > - To have a slide with no title use “## !”.
> > - To have hard new lines use + at the end of line.
> > - Dark themes are good for screen but generally look poor on
> projectors,
> > modified the css to be black text on white and use a more common
> fonts with
> > fallbacks.
> >
>
> It'd be great if we could have the CSS in some "common" directory so
> not
> everything repeats the basic stuff.
>
>
> >
> > Al in all it was fairly easy to convert but there is a couple of
> rough
> > corners.
> > - Work out how to crop images and video so it the same as in the
> original
> > presentation.
> > - Footer is not showing for some unknown reason.
> > - Move titles to top of page rather than entering comment.
> > - Annoying to have to rename index.revealjs to index.html all the
> time.
> >
>
> Yes, this is super annoying! Also...it creates a WAR file? There's also
> commented out stuff in the pom etc.
> The install-deps.sh is for MacOS only and has no documentation, is it
> really needed? What for?
>
>
> > Questions:
> > - While there's no branding (other than the ASF) it does have my
> name on
> > it and a slide or two assumes I’m the person given it. Do we want to
> make
> > it more anonymous?
> >
>
> I'm in favor of making it anonymous, yes. A similar reason to the
> @author
> tags. This information is prone to go stale as more people contribute
> to it.
>
>
> > - Have I put it in the right place?
> > - What can we do to cut down on duplication? There's a few files I
> copies
> > and duplicated from Chris’s example.
> > - It builds on it own but not as part of the whole repo. Do we want
> to do
> > that?
> >
>
> Well, this is my vision and nothing more: Yes, it's in the right place,
> mostly. But it shouldn't contain the pom.xml and reveal stuff
> (template,
> css). In my mind we'd have a "content" repository in the "content"
> folder
> (including asciidoc, jpg, mp4 files etc.) and then assemble that with
> yet
> to be designed tools (or shell scripts) in the "sessions" folder which
> would hopefully allow us to reuse css and other things.
>
>
> >
> > Thanks,
> > Justin
>
>
>
Re: New Reveal.JS Presentation Template
Posted by Christofer Dutz <ch...@c-ware.de>.
HI Lars,
that the generator creates index.revealjs came in when updating to Asciidoctor 2.
I am certain we can figure out why this happens and change it back to index.html. I don't see a huge issue with that.
I generate a war as in order for all operations of the presentation to work, it needs to be loaded with http or https. When using "file", some JavaScript doesn't work.
That's why I package it as war and run it with the jetty plugin.
The presentation is runnable with:
mvn package jetty:run-exploded
I did mention that the install-deps is a script I wrote for myself on my Mac and that we need to adjust it to other platform.
I have a lot of examples in the template that utilize different external tools. In order to work, they need to be installed.
You don't need all of them, just the ones you need in your presentation.
As I mentioned in my email before, I commented out the reference to the extensions lab which generates my diagrams as this
didn't work after updating and I need to fix that before we can use it. But I remember people mentioning that they didn't like
how those charts looked.
Chris
Am 29.04.19, 19:48 schrieb "Lars Francke" <la...@gmail.com>:
Hi,
I just added a review on Github and had a couple of comments which you
mostly addressed here so I'll continue the conversation here. As we didn't
have a review for Chris' stuff this is mostly not about what you added
Justin but about the template itself.
On Sat, Apr 27, 2019 at 9:01 AM Justin Mclean <ju...@classsoftware.com>
wrote:
> Hi,
>
> So using Chris template I converted a set of my own slides and submitted a
> PR with it.
>
> Some notes:
> - Make sure you spell asciidoc directory correctly otherwise it will
> compile but produce nothing :-)
> - To have a slide with no title use “## !”.
> - To have hard new lines use + at the end of line.
> - Dark themes are good for screen but generally look poor on projectors,
> modified the css to be black text on white and use a more common fonts with
> fallbacks.
>
It'd be great if we could have the CSS in some "common" directory so not
everything repeats the basic stuff.
>
> Al in all it was fairly easy to convert but there is a couple of rough
> corners.
> - Work out how to crop images and video so it the same as in the original
> presentation.
> - Footer is not showing for some unknown reason.
> - Move titles to top of page rather than entering comment.
> - Annoying to have to rename index.revealjs to index.html all the time.
>
Yes, this is super annoying! Also...it creates a WAR file? There's also
commented out stuff in the pom etc.
The install-deps.sh is for MacOS only and has no documentation, is it
really needed? What for?
> Questions:
> - While there's no branding (other than the ASF) it does have my name on
> it and a slide or two assumes I’m the person given it. Do we want to make
> it more anonymous?
>
I'm in favor of making it anonymous, yes. A similar reason to the @author
tags. This information is prone to go stale as more people contribute to it.
> - Have I put it in the right place?
> - What can we do to cut down on duplication? There's a few files I copies
> and duplicated from Chris’s example.
> - It builds on it own but not as part of the whole repo. Do we want to do
> that?
>
Well, this is my vision and nothing more: Yes, it's in the right place,
mostly. But it shouldn't contain the pom.xml and reveal stuff (template,
css). In my mind we'd have a "content" repository in the "content" folder
(including asciidoc, jpg, mp4 files etc.) and then assemble that with yet
to be designed tools (or shell scripts) in the "sessions" folder which
would hopefully allow us to reuse css and other things.
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Lars Francke <la...@gmail.com>.
Hi,
I just added a review on Github and had a couple of comments which you
mostly addressed here so I'll continue the conversation here. As we didn't
have a review for Chris' stuff this is mostly not about what you added
Justin but about the template itself.
On Sat, Apr 27, 2019 at 9:01 AM Justin Mclean <ju...@classsoftware.com>
wrote:
> Hi,
>
> So using Chris template I converted a set of my own slides and submitted a
> PR with it.
>
> Some notes:
> - Make sure you spell asciidoc directory correctly otherwise it will
> compile but produce nothing :-)
> - To have a slide with no title use “## !”.
> - To have hard new lines use + at the end of line.
> - Dark themes are good for screen but generally look poor on projectors,
> modified the css to be black text on white and use a more common fonts with
> fallbacks.
>
It'd be great if we could have the CSS in some "common" directory so not
everything repeats the basic stuff.
>
> Al in all it was fairly easy to convert but there is a couple of rough
> corners.
> - Work out how to crop images and video so it the same as in the original
> presentation.
> - Footer is not showing for some unknown reason.
> - Move titles to top of page rather than entering comment.
> - Annoying to have to rename index.revealjs to index.html all the time.
>
Yes, this is super annoying! Also...it creates a WAR file? There's also
commented out stuff in the pom etc.
The install-deps.sh is for MacOS only and has no documentation, is it
really needed? What for?
> Questions:
> - While there's no branding (other than the ASF) it does have my name on
> it and a slide or two assumes I’m the person given it. Do we want to make
> it more anonymous?
>
I'm in favor of making it anonymous, yes. A similar reason to the @author
tags. This information is prone to go stale as more people contribute to it.
> - Have I put it in the right place?
> - What can we do to cut down on duplication? There's a few files I copies
> and duplicated from Chris’s example.
> - It builds on it own but not as part of the whole repo. Do we want to do
> that?
>
Well, this is my vision and nothing more: Yes, it's in the right place,
mostly. But it shouldn't contain the pom.xml and reveal stuff (template,
css). In my mind we'd have a "content" repository in the "content" folder
(including asciidoc, jpg, mp4 files etc.) and then assemble that with yet
to be designed tools (or shell scripts) in the "sessions" folder which
would hopefully allow us to reuse css and other things.
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Christofer Dutz <ch...@c-ware.de>.
HI Justin ... the original mechanism of adding footer and header didn't work for me, so I hacked them in in the:
tools/maven-revealjs-asciidoctor-templte/libs/docinfo-hack/document.html.slim
File
Perhaps together we can find a way to fix this ... I would be really glad to get rid of that file and remove it from the notice.
Chris
Am 28.04.19, 04:58 schrieb "Justin Mclean" <ju...@classsoftware.com>:
Hi,
> - Footer is not showing for some unknown reason.
Looks like footer are a little broken, you can replace the footer but even when using the no footer attribute it adds it rather than replacing it. You could assign differ classes but having two things with similar name seem wrong. I ended up just editing the style template to do this.
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> - Footer is not showing for some unknown reason.
Looks like footer are a little broken, you can replace the footer but even when using the no footer attribute it adds it rather than replacing it. You could assign differ classes but having two things with similar name seem wrong. I ended up just editing the style template to do this.
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Christofer Dutz <ch...@c-ware.de>.
Hi all,
asciidoctor does allow variables that can be provided ... perhaps we should use these to have the author and event generated into the presentation during the build.
Chris
Am 27.04.19, 10:02 schrieb "Dmitriy Pavlov" <dp...@apache.org>:
Justin, Devs,
Thank you for the first content contribution, it is so needed now because
it helps to set up the project and shows others how to contribute.
> Do we want to make it more anonymous?
I personally estimate that if we can keep individuals' names in the
content, it could be good for community building.
We can also consider including all contributors' names to release notes.
Sincerely,
Dmitriy Pavlov
сб, 27 апр. 2019 г. в 10:01, Justin Mclean <ju...@classsoftware.com>:
> Hi,
>
> So using Chris template I converted a set of my own slides and submitted a
> PR with it.
>
> Some notes:
> - Make sure you spell asciidoc directory correctly otherwise it will
> compile but produce nothing :-)
> - To have a slide with no title use “## !”.
> - To have hard new lines use + at the end of line.
> - Dark themes are good for screen but generally look poor on projectors,
> modified the css to be black text on white and use a more common fonts with
> fallbacks.
>
> Al in all it was fairly easy to convert but there is a couple of rough
> corners.
> - Work out how to crop images and video so it the same as in the original
> presentation.
> - Footer is not showing for some unknown reason.
> - Move titles to top of page rather than entering comment.
> - Annoying to have to rename index.revealjs to index.html all the time.
>
> Questions:
> - While there's no branding (other than the ASF) it does have my name on
> it and a slide or two assumes I’m the person given it. Do we want to make
> it more anonymous?
> - Have I put it in the right place?
> - What can we do to cut down on duplication? There's a few files I copies
> and duplicated from Chris’s example.
> - It builds on it own but not as part of the whole repo. Do we want to do
> that?
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
>> Do we want to make it more anonymous?
> I personally estimate that if we can keep individuals' names in the
> content, it could be good for community building.
It can also have the opposite effect i.e this content belongs to X and people are reluctant to edit it / make changes to it.
What possible could be done is:
a) I submit a SGA [1] Given the content is already ALv2 is this needed?
b) My copyright statements are relocated to NOTICE file.
I also made my name a token that can be replaced in the content on generation if someone else want to give the presentation.
> We can also consider including all contributors' names to release notes.
I seen other projects do this with CONTRIBUTORS file, but they can be a little annoying to maintain.
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Dmitriy Pavlov <dp...@apache.org>.
Justin, Devs,
Thank you for the first content contribution, it is so needed now because
it helps to set up the project and shows others how to contribute.
> Do we want to make it more anonymous?
I personally estimate that if we can keep individuals' names in the
content, it could be good for community building.
We can also consider including all contributors' names to release notes.
Sincerely,
Dmitriy Pavlov
сб, 27 апр. 2019 г. в 10:01, Justin Mclean <ju...@classsoftware.com>:
> Hi,
>
> So using Chris template I converted a set of my own slides and submitted a
> PR with it.
>
> Some notes:
> - Make sure you spell asciidoc directory correctly otherwise it will
> compile but produce nothing :-)
> - To have a slide with no title use “## !”.
> - To have hard new lines use + at the end of line.
> - Dark themes are good for screen but generally look poor on projectors,
> modified the css to be black text on white and use a more common fonts with
> fallbacks.
>
> Al in all it was fairly easy to convert but there is a couple of rough
> corners.
> - Work out how to crop images and video so it the same as in the original
> presentation.
> - Footer is not showing for some unknown reason.
> - Move titles to top of page rather than entering comment.
> - Annoying to have to rename index.revealjs to index.html all the time.
>
> Questions:
> - While there's no branding (other than the ASF) it does have my name on
> it and a slide or two assumes I’m the person given it. Do we want to make
> it more anonymous?
> - Have I put it in the right place?
> - What can we do to cut down on duplication? There's a few files I copies
> and duplicated from Chris’s example.
> - It builds on it own but not as part of the whole repo. Do we want to do
> that?
>
> Thanks,
> Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> where in the process do you have to write asciidoc?
For the slide content, but it nothing complex. just headlines and bullet points and images.
> .It was never planned to be usable out of the box ... If you guys like the template this is a great base for us to work together to make it perfect or as perfect as possible.
I was able to get something working quite quickly and it looks reasonable so I’m happy with it. And once in this form working on the content in version control is so much nicer.
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Christofer Dutz <ch...@c-ware.de>.
Hi Justin,
where in the process do you have to write asciidoc? ... it should be "mvn package" ...
Regarding the rough edges ... I agree and there have been things I had workarounds and I would be glad if others could help with this ... especially with the headers and footers I had to manipulate the template and add CSS rules. Which is not ideal.
It was never planned to be usable out of the box ... If you guys like the template this is a great base for us to work together to make it perfect or as perfect as possible.
Chris
Am 27.04.19, 09:01 schrieb "Justin Mclean" <ju...@classsoftware.com>:
Hi,
So using Chris template I converted a set of my own slides and submitted a PR with it.
Some notes:
- Make sure you spell asciidoc directory correctly otherwise it will compile but produce nothing :-)
- To have a slide with no title use “## !”.
- To have hard new lines use + at the end of line.
- Dark themes are good for screen but generally look poor on projectors, modified the css to be black text on white and use a more common fonts with fallbacks.
Al in all it was fairly easy to convert but there is a couple of rough corners.
- Work out how to crop images and video so it the same as in the original presentation.
- Footer is not showing for some unknown reason.
- Move titles to top of page rather than entering comment.
- Annoying to have to rename index.revealjs to index.html all the time.
Questions:
- While there's no branding (other than the ASF) it does have my name on it and a slide or two assumes I’m the person given it. Do we want to make it more anonymous?
- Have I put it in the right place?
- What can we do to cut down on duplication? There's a few files I copies and duplicated from Chris’s example.
- It builds on it own but not as part of the whole repo. Do we want to do that?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
So using Chris template I converted a set of my own slides and submitted a PR with it.
Some notes:
- Make sure you spell asciidoc directory correctly otherwise it will compile but produce nothing :-)
- To have a slide with no title use “## !”.
- To have hard new lines use + at the end of line.
- Dark themes are good for screen but generally look poor on projectors, modified the css to be black text on white and use a more common fonts with fallbacks.
Al in all it was fairly easy to convert but there is a couple of rough corners.
- Work out how to crop images and video so it the same as in the original presentation.
- Footer is not showing for some unknown reason.
- Move titles to top of page rather than entering comment.
- Annoying to have to rename index.revealjs to index.html all the time.
Questions:
- While there's no branding (other than the ASF) it does have my name on it and a slide or two assumes I’m the person given it. Do we want to make it more anonymous?
- Have I put it in the right place?
- What can we do to cut down on duplication? There's a few files I copies and duplicated from Chris’s example.
- It builds on it own but not as part of the whole repo. Do we want to do that?
Thanks,
Justin
Re: New Reveal.JS Presentation Template
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> It’s built with Maven and should do most out of the box. However in the examples, I have a few special goodies that need some setup on your side. So If you see some ugly looking stuff where you are expecting charts, you’re probably missing something. In the template folder I did write up how to setup things and it contains a script I used to install my third party stuff … but not sure it works on every machine. I guess this will be something we should work on together.
JFYI The install was not working on my machine (OSX Mojave). I tried updating node and it broke for other reasons. :-(
First off "brew install stack” got me a little further, so you might want to add that to the install script.
The node error:
/usr/local/lib/node_modules/npm/bin/npm-cli.js:84
let notifier = require('update-notifier')({pkg})
^^^
SyntaxError: Block-scoped declarations (let, const, function, class) not yet supported outside strict mode
…
Which looks related to:
https://stackoverflow.com/questions/50316693/npm-update-broke-npm
Reinstalling npm fixed that as per that link and brew suggestions.
Thanks,
Justin