Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
    Alan Long
    @alalo_gitlab
    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.
    Andre Maia Chagas
    @amchagas
    hello world!
    Kaspar Emanuel
    @kasbah
    hi andre, to do a proper gitbuilding hello world you have to write it into some gitbuilding docs and post a screenshot :)
    Andre Maia Chagas
    @amchagas
    I know! Julian has already given me that task... :P
    hence me being here...
    Kaspar Emanuel
    @kasbah
    :thumbsup:
    Julian Stirling
    @julianstirling_gitlab
    Hi Andre, thanks for being here :D
    Ryan Fobel
    @ryanfobel_gitlab
    Hey all, been actively using gitbuilding on several projects over the past few weeks and am really loving it. I've gotten to the point where I'd like to start contributing/developing some new features. Is this the best place to discuss?
    Julian Stirling
    @julianstirling_gitlab
    We set it up to have discussions, but then there was never much discussion. Would be cool to have more contributions
    Paul Clifton
    @STS-Paul_gitlab
    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.
    Julian Stirling
    @julianstirling_gitlab
    They should point to gitbuilding.io as we registered the domain and use that. Probably what happened is that we reorganised the website and a lot of the links are now dead. Thanks for the heads up
    Jeremy Wright
    @jmwright_gitlab
    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.
    Julian Stirling
    @julianstirling_gitlab
    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.
    Jeremy Wright
    @jmwright_gitlab
    Thanks @julianstirling_gitlab I'm hoping to spend some time getting up to speed on GitBuilding over the coming weeks.
    Julian Stirling
    @julianstirling_gitlab
    Great. It has mostly been used by a small group of devs (well mostly me), so I can imagine the the documentation make be lacking in places. Let us know if you have any issues
    Jeremy Wright
    @jmwright_gitlab
    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?
    Jeremy Wright
    @jmwright_gitlab
    I also tried cloning the repo, checking out the v0.8.4 tag, then installing all the deps and then installing via python3 setup.py install. I still get the same error.
    Julian Stirling
    @julianstirling_gitlab
    that is very worrying!! I am 20.04 but it should work the same. I will try to work this out and get back to you
    Jeremy Wright
    @jmwright_gitlab
    I tried it on a Pop OS 20.10 machine (based on Ubuntu 20.10 with Python 3.8.6 and GitBuilding seems to work fine. I'll use Anaconda to force a newer version of Python on Ubuntu 18.04 to try to determine if there is an incompatibility with Python 3.6.x.
    Julian Stirling
    @julianstirling_gitlab
    If that is the case I can add a python 3.6 check to the CI and then push out a patch. We say 3.6 or greater but we only test 3.7
    3.6 is required because my early implementation used f strings so heavily that I had no intention of going back and fixing it!!
    Jeremy Wright
    @jmwright_gitlab
    Ok, I just confirmed it. I created 3 environments with Miniconda, from Python 3.6 up thru Python 3.8. 3.8 worked with no errors or warnings. 3.7 gave a few dependency errors when I installed gitbuilding but worked fine. 3.6 threw the buildup error.
    Jeremy Wright
    @jmwright_gitlab
    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?
    Jeremy Wright
    @jmwright_gitlab
    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.
    Jeremy Wright
    @jmwright_gitlab
    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.
    Julian Stirling
    @julianstirling_gitlab
    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
    Jeremy Wright
    @jmwright_gitlab
    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.
    Jeremy Wright
    @jmwright_gitlab
    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?
    Julian Stirling
    @julianstirling_gitlab
    could configure it in the configuration files on whether you want weblinks to be in a new tab?
    Jeremy Wright
    @jmwright_gitlab
    Sure, that would be great.
    GitBuilding doesn't already do that, does it?
    Jeremy Wright
    @jmwright_gitlab
    Doesn't look like it based on the docs.
    Jeremy Wright
    @jmwright_gitlab
    Is there an accepted way to mark a step as optional? Put "(Optional)" in the title, "Optional" in the Note, or both? Something else maybe?
    Julian Stirling
    @julianstirling_gitlab
    Hmm not for an optional step. You can add notes to parts..
    Jeremy Wright
    @jmwright_gitlab
    Screenshot from 2021-06-09 16-38-50.png
    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.
    Screenshot from 2021-06-09 16-46-26.png
    Jeremy Wright
    @jmwright_gitlab
    Right now what I'm doing is prefixing the Note with something like " - " to give it some separation.
    Julian Stirling
    @julianstirling_gitlab
    yes. In master the " - " should ba added automatically as I found I was doing the exact same thing
    Jeremy Wright
    @jmwright_gitlab
    Image galleries are supported which I think is really great, but I don't see anything about image captions in the docs. Are captions available?
    Julian Stirling
    @julianstirling_gitlab
    No, but probably should be. Would you be happy opening some of these suggestiosn as GitLab issues so I don't forget them?
    Jeremy Wright
    @jmwright_gitlab
    Sure. I didn't want to flood your issue tracker with noob questions at the beginning, but I've got a simple project documented in GitBuilding now, and I'll go back through and pick out some of the things I brought up here on Gitter.
    Julian Stirling
    @julianstirling_gitlab
    Fantastic, thanks so much. Really interesting to see how someone new experiences the project
    Jeremy Wright
    @jmwright_gitlab
    Sorry, please ignore that last message. I wasn't paying enough attention and it's published my readme. The workflow that's generated by GitBuilding is running without an error, but the page isn't showing up.
    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/
    Julian Stirling
    @julianstirling_gitlab
    Looks good. I had planned to go through some f your points with Kaspar on tuesday at our bi-weekly code session. We got distracted with non-GitBuilding things. Hopefully we will get a chance next time.
    Jeremy Wright
    @jmwright_gitlab
    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.
    Screenshot from 2021-06-18 13-41-43.png