Skip to content
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

07/04/2021: Add some form of build documentation to either readme or contributing #300

Open
bjthorpe opened this issue Apr 7, 2021 · 2 comments
Labels
question Further information is requested

Comments

@bjthorpe
Copy link

bjthorpe commented Apr 7, 2021

As a new user, I noticed there is a severe lack of instructions on how to check or build the glossario. The readme makes a passing mention to Jeckyl (google was my friend in that case) and contributing just has the line "In case you wish to build up the website locally to double-check the final look, you can use make serve" which if you use it without first instaling Jeckyl gives a bunch of confusing errors. So should we add installation instructions for Jeckyl? or at least a link to them as there is no need to get too detailed here. Also, I would perhaps suggest we expand the section in contributing to include make check.

@bjthorpe bjthorpe added the question Further information is requested label Apr 7, 2021
@bjthorpe bjthorpe changed the title [DATE]: [ISSUE] Add some form of build documentation to either readme or contributing 07/04/2021: Add some form of build documentation to either readme or contributing Apr 7, 2021
@bjthorpe
Copy link
Author

bjthorpe commented Apr 7, 2021

My idea for a possible fix #301

@baileythegreen
Copy link
Contributor

Just left some feedback on the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants