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
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 😃)
There is a very simple example with a GitLab pages CI here:
https://gitlab.com/gitbuilding/gitbuilding-example
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/
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
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).
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...) ???
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...
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
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.
Etc.
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.
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
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
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}
Did I miss anything?
Additions? Corrections? Deletions?
Next to list the relationships among them
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?
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.
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!
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!
@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
I wonder how much of Gitbuilding markdown (BuildUp) we could do as generic directives