Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
    Julian Stirling
    @julianstirling_gitlab
    Probably email would be the easiest
    Bob Haugen
    @bhaugen
    Thanks.
    Julian Stirling
    @julianstirling_gitlab
    We are going to have a discussion about future syntax of GitBuilding. Anyone is welcome, we are using this poll to schedule the meeting https://crab.fit/gitbuilding-syntax-discussion-781804
    Blaise Thompson
    @untzag:matrix.org
    [m]
    Are there any examples of using gitbuilding within CI? I'm especially interested in automatic deployment to e.g. github pages and automatic PDF generation for "releases" of a hardware project.
    (sorry if I'm WAY off track I'm not really sure what the goals of this project are 😃)
    Julian Stirling
    @julianstirling_gitlab
    Yeah. So you should be able to use the gitbuilding generate ci command to write the CI scripts for GitLab CI, GitHub Actions, or Netlify.
    There is a very simple example with a GitLab pages CI here:
    https://gitlab.com/gitbuilding/gitbuilding-example
    For the OpenFlexure microscope we have a much more complex CI that uses GitBuilding on artifacts from other CI jobs (creating the rendered images and STL files) and then deploying them to an external server:
    https://gitlab.com/openflexure/openflexure-microscope/
    I have not run the PDF on CI but there is no reason it should not work, you would need to add to the CI script to install WeasyPrint
    Blaise Thompson
    @untzag:matrix.org
    [m]
    Wow thanks! I'll try this for my next project
    Julian Stirling
    @julianstirling_gitlab
    Great, let us know how it goes.
    Bob Haugen
    @bhaugen
    The conversation with FabCity continues. Pieter Hijma gave a presentation about maker doc today mentioned GitBuilding prominently.
    Lynn Foster and I would like to find or reverse engineer a data model for GitBuilding. Has anybody done anything like that and we could just adopt it?
    Otherwise we'll try to reverse engineer one and present it here for review (or someplace else of your choice).
    Julian Stirling
    @julianstirling_gitlab
    We don't have a proper data model specified. Starting to think that we should
    Bob Haugen
    @bhaugen
    Ok, we'll take a stab at it and you all can correct it.
    Bob Haugen
    @bhaugen
    Is this a good place to ask questions about GitBuilding details? Or would you prefer that I ask them somewhere else?
    Bob Haugen
    @bhaugen
    These will start out at pretty ignorant questions. For example, https://gitlab.com/gitbuilding/gitbuilding-example/-/blob/master/original_lunch.md lists 5 steps, like 1..{step}
    How is each step selected from https://gitlab.com/gitbuilding/gitbuilding-example files? Which is Step 1, Step 2, etc?
    On https://gitbuilding.gitlab.io/gitbuilding-example/original_lunch.html I can see that pressureham.md is the first step, but https://gitlab.com/gitbuilding/gitbuilding-example/-/blob/master/pressureham.md does not say that it is a Step, and nothing obvious designates that as the first step. (But I am obviously missing something...) ???
    So a bunch of questions and answers like that will occupy a lot of this gitter channel...
    Julian Stirling
    @julianstirling_gitlab
    The link to having {step} is what defines pressureham.md as a step.
    The order is defined by the order of use on the calling page. We might have an option to over-rule that later
    i.e. in the header of a page that has a number of steps it could have some YAML data to re-order that perhaps. This is not something planned soon, but something I have thought about
    Bob Haugen
    @bhaugen

    The link to having {step} is what defines pressureham.md as a step.

    Where would I see that link?

    The order is defined by the order of use on the calling page

    Which is the calling page?

    Sorry if both of those should have been obvious. It's still a bit bewildering to me.
    Bob Haugen
    @bhaugen

    in the header of a page that has a number of steps it could have some YAML data to re-order that perhaps.

    I would prefer a topological sort. I'll think about if it's possible to do that from GitBuilding data and if so, how, once I think I understand the data model better.

    Bob Haugen
    @bhaugen
    Topological sort is based on predecessors. Whatever has no predecessors gets sorted first. After those, their successors.
    Etc.
    Julian Stirling
    @julianstirling_gitlab
    Thinking from the perspective of the person writing documentation. I can write a page like "how to make a ham sandwich"
    This page can be stand alone.
    This page can be the first step of making a toasted ham sandwich
    This page can be part of a lunch which has a ham sandwich
    This page can be part of a smorgasbord with loads of stuff and a ham sandwich
    This page can me just one part of how to make a ham sandwich catapult.
    It is up to the person making a page that needs to use an instruction to ask for it. The instruction itself is agnostic as to what is being made in the end
    Bob Haugen
    @bhaugen

    Is there a page somewhere in the ham sandwich doc that references the pressureham.md page as the first step?
    This is interesting: https://gitlab.com/search?search=pressureham&project_id=9353410&group_id=7833633&nav_source=navbar
    shows
    original_lunch.md

    Steps

    1. .{step}
    2. .{step}
    3. .{step}

    Actually, on screen, and when I edit, it shows pressureham.md but you can't see it when I post it.

    I could show you a screenshot or you could just click on that link.

    but https://gitlab.com/gitbuilding/gitbuilding-example/-/blob/master/original_lunch.md just shows
    Steps

    .{step}

    .{step}

    .{step}

    .{step}

    .{step}

    Bob Haugen
    @bhaugen
    I probly need to install the gitbuilding software to understand better....
    Bob Haugen
    @bhaugen
    Looks like I will need to upgrade my ubuntu version to do this. Over the weekend...
    Bob Haugen
    @bhaugen
    Ok, upgraded ubuntu, installed gitbuilding
    Bob Haugen
    @bhaugen
    Preliminary list of data model classes/tables:
    • Project
    • Page
    • Step
    • Part
    • Tool (are Tools also Part Cat: Tool?)
    Did I miss anything?
    Additions? Corrections? Deletions?
    Next to list the relationships among them
    Bob Haugen
    @bhaugen
    In order to explore a bit more, how can I open one of the https://gitbuilding.io/usage/complex-projects in the gitbuilding browser/editor?
    By the way, I like the editor a lot!
    Even better, after one of the complex projects, how can I open the openflexure microscope gitbuilding files in the editcor?
    Julian Stirling
    @julianstirling_gitlab
    I suppose in my head there is a project, made up of pages. Pages have parts on them (this parts can be categorised as a tool or as any other custom category). Pages are linked together by "step links"
    Bob Haugen
    @bhaugen
    Thanks, Julian.
    Bob Haugen
    @bhaugen

    Looks like steps can be sequenced via either:

    • a list of steps in the Project index page, or
    • via a step link in another page, or
    • by a fromstep link using an output from another step.

    Looks like those sequences could disagree: for example, the list in the Project page could put a step that depends on a fromstep output ahead of the step that produces the output.

    Julien Moreau
    @Boorhin
    Hi there, I have a question regarding the use of pygments in inserting code. The example shows for python
    3backticks{.python}
    my code
    3backticks
    However I am not sure how I could for example use the different styles
    https://pygments.org/styles/
    Or basically what kind of command are we sending when we write .python
    I am also interested in highlighting bash and that kind of things
    Cheers!
    Kaspar Emanuel
    @kasbah
    @Boorhin sorry about the late response. It's not yet possible to customise the styles, I've created an issue for it: gitbuilding/gitbuilding#246
    Kaspar Emanuel
    @kasbah
    I wonder how much of Gitbuilding markdown (BuildUp) we could do as generic directives