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

Community Video Call - Wed 17 Jan @ 2000 UTC #133

Open
bexelbie opened this Issue Jan 15, 2018 · 12 comments

Comments

Projects
None yet
4 participants
@bexelbie
Contributor

bexelbie commented Jan 15, 2018

Their will be a call to talk about the roadmap for AsciiBinder - potential topics include:

  • Plans and Goals for the Project
    • Markdown support?
  • Next Release Goals
  • Next Meeting/Cadence

Feel free to add more topics in this issue.

The meeting will take place on meet.jitsi.com. The meeting url will be posted before the call in this ticket.

Please consider subscribing to the ticket if you are interested in getting an email when the call url is posted.

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie

bexelbie Jan 15, 2018

Contributor

I apologize for the late posting of this - the committers set the date a while back and I failed to get the information posted soon enough.

Contributor

bexelbie commented Jan 15, 2018

I apologize for the late posting of this - the committers set the date a while back and I failed to get the information posted soon enough.

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie

bexelbie Jan 15, 2018

Contributor

@nhr - how can I update the website with this? I'll put a PR in momentarily.

Contributor

bexelbie commented Jan 15, 2018

@nhr - how can I update the website with this? I'll put a PR in momentarily.

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie
Contributor

bexelbie commented Jan 15, 2018

@nhr

This comment has been minimized.

Show comment
Hide comment
@nhr

nhr Jan 15, 2018

Contributor

@bexelbie I'll just manually build and publish for now. Let me know when you are ready for me to do that.

Contributor

nhr commented Jan 15, 2018

@bexelbie I'll just manually build and publish for now. Let me know when you are ready for me to do that.

@indigo423

This comment has been minimized.

Show comment
Hide comment
@indigo423

indigo423 Jan 15, 2018

Thank you for an invitation, try to get my schedule free for the community video call. Looking forward with greetings from Europe, Stuttgart. I will be unavailable from 15:15 until 16:30

indigo423 commented Jan 15, 2018

Thank you for an invitation, try to get my schedule free for the community video call. Looking forward with greetings from Europe, Stuttgart. I will be unavailable from 15:15 until 16:30

@nigelbabu

This comment has been minimized.

Show comment
Hide comment
@nigelbabu

nigelbabu Jan 17, 2018

Blah, 1 am for me. But I'll catch up with @bexelbie afterward :)

nigelbabu commented Jan 17, 2018

Blah, 1 am for me. But I'll catch up with @bexelbie afterward :)

@indigo423

This comment has been minimized.

Show comment
Hide comment
@indigo423

indigo423 Jan 17, 2018

Did I missed something :)

indigo423 commented Jan 17, 2018

Did I missed something :)

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie

bexelbie Jan 17, 2018

Contributor

@indigo423 not yet :) @nigelbabu was letting us know he can't be there as his timezone is not terribly conducive to attendance. Call is in 1.25 hours from time on this comment.

Contributor

bexelbie commented Jan 17, 2018

@indigo423 not yet :) @nigelbabu was letting us know he can't be there as his timezone is not terribly conducive to attendance. Call is in 1.25 hours from time on this comment.

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie
Contributor

bexelbie commented Jan 17, 2018

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie

bexelbie Jan 17, 2018

Contributor

Meeting Etherpad for minutes http://etherpad.osuosl.org/1rl56dEQ88

Contributor

bexelbie commented Jan 17, 2018

Meeting Etherpad for minutes http://etherpad.osuosl.org/1rl56dEQ88

@indigo423

This comment has been minimized.

Show comment
Hide comment
@indigo423

indigo423 Jan 17, 2018

Thank you for organizing this very constructive meeting.

indigo423 commented Jan 17, 2018

Thank you for organizing this very constructive meeting.

@bexelbie

This comment has been minimized.

Show comment
Hide comment
@bexelbie

bexelbie Jan 23, 2018

Contributor

I am putting the etherpad minutes here for preservation. I am going to leave this open until the next meeting to reference the areas of focus here. Ideally this will get converted into assignments and tasks in Github.

Areas of focus

  • Search - ideally bex and indigo423 to work on this

    • With plain asciidoc there was a single page - now with multi-page we need to deal with search
    • There is the Gluster AB search plugin - but it suffers from usability perspective (our image for the Gluster AB search plugin: https://github.com/opennms-forge/docker-asciibinder-search)
      • can we some how solve search?
      • In the static CMS Hugo (http://gohugo.io) there is a quite smart JavaScript client side search functionality implemented. Probably we can leverage here. Here is an working live docs example from one of our tools I maintain: https://pris.opennms.eu. This is what the Hugo project is using for JavaScript and cliend side search: https://lunrjs.com
      • Openshift uses an homegrown option after Google Search went down
      • There are some other online options
      • A challenge is that a low impact static website from AB is made potentially very heavy by a search engine and java script may not (and so far has not) scaled well
      • We should leverage outside search solutions and not invent our own as much as possible
      • could we produce a google standard sitemap
      • we generate a sitemap in XML today that is google standard for google custom search so leverage this
  • Goals from nhr to all of us (and we liked them) from his time as essentially sole maintainer

    • make subdirectory builds work - nhr to work on this
    • add easier image locations (fix some hard coded directories) - nhr to work on this
  • Add generic vars support #126 - bex to work on this

    • Needs tests
    • No concerns raised on the call
    • It may gather some usage
  • Add support for unlimited navigation templates - #122 - bex to work on this

    • code comment: the code for AB supports arbitrary depth but is currently hard limited at depth of 2 because the templates currently do not support more
    • philosophy issues - other than concerns about encouraging bad deep docs, none
  • Vikram going to triage the docs issues and resolve them

  • Markdown - not going to push this for now

    • Markdown does not support ifdef for content conditionalization in a topic. This means that we lose that functionality in markdown. This could be reimplemented with pre_post processing or by using directories and doing duplicate content
    • This could also cause issues with "single doc html" and "pdf" generation from the repo
    • This means AB as a tool needs a similar markdown gem - this works for AsciiDoc but system calls or other challenges to call parsers could create scale problems
    • we need a way to not drag in unneeded dependencies for installations that don't need it
    • polling the call there is no requirement other than possibly from Fedora
    • a potential benefit of adding this enforces a separate of rendering engine from AB's work as a site builder
    • if this moves forward it needs to be rebased and get testing, including a test repo

Next Meeting in early March. Normally we would do monthly meetings, but there is a Fedora Docs FAD at the end of February that will hopefully generate some code commits for AB.

Contributor

bexelbie commented Jan 23, 2018

I am putting the etherpad minutes here for preservation. I am going to leave this open until the next meeting to reference the areas of focus here. Ideally this will get converted into assignments and tasks in Github.

Areas of focus

  • Search - ideally bex and indigo423 to work on this

    • With plain asciidoc there was a single page - now with multi-page we need to deal with search
    • There is the Gluster AB search plugin - but it suffers from usability perspective (our image for the Gluster AB search plugin: https://github.com/opennms-forge/docker-asciibinder-search)
      • can we some how solve search?
      • In the static CMS Hugo (http://gohugo.io) there is a quite smart JavaScript client side search functionality implemented. Probably we can leverage here. Here is an working live docs example from one of our tools I maintain: https://pris.opennms.eu. This is what the Hugo project is using for JavaScript and cliend side search: https://lunrjs.com
      • Openshift uses an homegrown option after Google Search went down
      • There are some other online options
      • A challenge is that a low impact static website from AB is made potentially very heavy by a search engine and java script may not (and so far has not) scaled well
      • We should leverage outside search solutions and not invent our own as much as possible
      • could we produce a google standard sitemap
      • we generate a sitemap in XML today that is google standard for google custom search so leverage this
  • Goals from nhr to all of us (and we liked them) from his time as essentially sole maintainer

    • make subdirectory builds work - nhr to work on this
    • add easier image locations (fix some hard coded directories) - nhr to work on this
  • Add generic vars support #126 - bex to work on this

    • Needs tests
    • No concerns raised on the call
    • It may gather some usage
  • Add support for unlimited navigation templates - #122 - bex to work on this

    • code comment: the code for AB supports arbitrary depth but is currently hard limited at depth of 2 because the templates currently do not support more
    • philosophy issues - other than concerns about encouraging bad deep docs, none
  • Vikram going to triage the docs issues and resolve them

  • Markdown - not going to push this for now

    • Markdown does not support ifdef for content conditionalization in a topic. This means that we lose that functionality in markdown. This could be reimplemented with pre_post processing or by using directories and doing duplicate content
    • This could also cause issues with "single doc html" and "pdf" generation from the repo
    • This means AB as a tool needs a similar markdown gem - this works for AsciiDoc but system calls or other challenges to call parsers could create scale problems
    • we need a way to not drag in unneeded dependencies for installations that don't need it
    • polling the call there is no requirement other than possibly from Fedora
    • a potential benefit of adding this enforces a separate of rendering engine from AB's work as a site builder
    • if this moves forward it needs to be rebased and get testing, including a test repo

Next Meeting in early March. Normally we would do monthly meetings, but there is a Fedora Docs FAD at the end of February that will hopefully generate some code commits for AB.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment