So many users of the site will only want to consume the work of others in which case providing them a simple UI like this makes a lot of sense I think. With that said it will be important to think about how we encourage users to move from consuming to contributing and make that process frictionless.
hence me being here...
I just noticed that some of the links in the ReadMe are broken - point to gitbuilding.io instead of gitlab.gitbuilding.io. I'll need to spend a minute to figure out how to submit bug reports, or contribute the fix, but I wanted to drop a note here in case I don't get a chance. Thanks for creating this.
Hi. Hopefully this question is clear since it's been a challenge to word it well. I was wondering if everyone publishes their GitBuilding projects as web pages, or if there is a precedent to do markdown builds and keep that as part of a repository on GitLab/GitHub and serve the instructions that way. What is the current best practice for using GitBuilding with a project that is maintained via a git repo? It seems like a GitHub page based on the contents of the repo, coupled with a CI system to trigger the GitBuilding build might be the easiest to keep in sync.
Hi Jeremy. What we have been doing is only keeping the GitBuilding source in the repo and then using GitLab pages or GitHub action to publish the website. If you run
gitbuilding generate ci, it should walk you through generating a scrip for either GitLab CI, GitHub actions, or Netlify. This should hopefully then be triggered once you push your repo to the remote.
I created a venv to contain my gitbuilding install using the Ubuntu 18.04 system version of Python (3.6.9). After activating the venv, I ran
pip install gitbuildingand got no errors (looks like it installed version 0.8.4). I then tried to run gitbuilding new and got an error saying AttributeError: module 'gitbuilding' has no attribute 'buildup'. What am I missing?
3.6 is required because my early implementation used f strings so heavily that I had no intention of going back and fixing it!!
Has there been talk about adding a filesystem watcher so that
gitbuilding serve will work with external editors (VS Code, emacs, etc)? Is there support for a feature request related to that? Also, is it intended that when I click the Edit button with the landing page selected, that both panes seem to fill with the content for a new page, rather than editing the landing page itself?
Looks like the edit button link for the landing page should point to
http://localhost:6178/landing.html/-/editor/ instead of http://localhost:6178/index.html/-/editor/. I'm assuming the exported html in _site turns landing.md into index.html though to avoid additional web server configuration though.
This should be my last one for this evening. I changed the hardware license in buildconf.yaml to match what I have on my repository, and now I get a warning:
Warning: License CERN-OHL-P set configuration. Could not match to licence text. I'm not sure what GitBuilding is matching against, but CERN-OHL-P should be a valid license code. I also just noticed that "license" is misspelled. I'm still learning GitBuilding, but I like where you're headed with it. I may want to retract my question about using external editors. BuildUp is just enough different that it creates a fair amount of friction with the markdown extension I use. Some syntax highlighting in GitBuilding's markdown editor would be very welcome though.
These are all really useful feedback. The landing page thing seems to be a bug. The file system watcher is something that would be good to do. Syntax highlighting I tried to do, but I suck at javascript and everything I tried broke something else. As for licenses we use the SPDX list: https://github.com/spdx/license-list-data/tree/master/text
Thanks, I had not put
-2.0 on the end of the CERN-OHL-P license identifier. That's fixed now. The editing bug only happens when at the root of the server (http://localhost:6178/). If you're at this address http://localhost:6178/landing.html clicking Edit has the intended behavior. A flash message instead of a popup after clicking Save (or at least when hitting Ctrl+S) would be helpful during busy editing sessions. Having to acknowledge the popup after saving adds some friction for somebody like me who compulsively saves.
I feel like it would be good if links to external sites opened in a new tab by default. Right now what I have is a link to the CadHub.xyz website where the user can modify, run and download a 3D model created in CadQuery. When I click on that, CadHub loads in the GitBuilding tab and the user loses their place in the docs. Normally I would embed html with
target=_blankto achieve this, but I'm not sure how that would work in GitBuilding's editor, and it seems a little clunky to mix HTML into markdown anyway. Thoughts?
GitBuilding doesn't already do that, does it?
It might be nice if a note on a part had some sort of indicator attached to it. Right now the part name and the note kind of run together. Maybe that's intended though?
Or maybe notes could be in a tooltip or in a text area that can be expanded/collapsed? I don't know, just throwing ideas out there.
Sorry, the previous screenshot of the rendered text was from the wrong spot.
Ok, I got it. Please let me know if there are things I need to improve about my use of GitBuilding's tools. https://7b-things.github.io/braille-signage-generator/
When I export my build docs to HTML, the tab title in the browser, title at the top of the page, and title in the nav bar on the left all say "Untitled Project". I didn't have that problem before I exported. I do have the Title value set in buildconf.yaml, so I'm not sure why this is happening.
