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

Add developer docs #206

Closed
MichaelCurrin opened this issue Mar 28, 2021 · 5 comments · Fixed by #212
Closed

Add developer docs #206

MichaelCurrin opened this issue Mar 28, 2021 · 5 comments · Fixed by #212

Comments

@MichaelCurrin
Copy link
Contributor

MichaelCurrin commented Mar 28, 2021

Hi,

I managed to get the project setup locally, but it was not straightforward because the docs cover end-users rather than developers.

Can I suggest docs/development.md.

@MichaelCurrin
Copy link
Contributor Author

MichaelCurrin commented Mar 28, 2021

Which has something like:

# Development
> Guide for developers working on this project

## Installation

Install Ruby, 

clone repo...

Run `bundle config ...` and `bundle install`


## Usage

Run all unit tests:

```sh
script/test 
```

Run specific unit tests:

```sh
script/test spec/owner_spec.rb
```

Run dev server for sample Jekyll site.

```sh
script/test-site
```

Then open in the browser at

- http://127.0.0.1:4000

And deployment either as a section there or as a short release.md doc. I don't know if more steps are needed but this is what I found.

# Release

```sh
script/release
```

@jekyllbot
Copy link
Contributor

This issue has been automatically marked as stale because it has not been commented on for at least two months.

The resources of the Jekyll team are limited, and so we are asking for your help.

If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.

If this is a feature request, please consider whether it can be accomplished in another way. If it cannot, please elaborate on why it is core to this project and why you feel more than 80% of users would find this beneficial.

This issue will automatically be closed in two months if no further activity occurs. Thank you for all your contributions.

@MichaelCurrin
Copy link
Contributor Author

I'll make a PR if no one has the time to.

@jekyllbot
Copy link
Contributor

This issue has been automatically marked as stale because it has not been commented on for at least two months.

The resources of the Jekyll team are limited, and so we are asking for your help.

If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.

If this is a feature request, please consider whether it can be accomplished in another way. If it cannot, please elaborate on why it is core to this project and why you feel more than 80% of users would find this beneficial.

This issue will automatically be closed in two months if no further activity occurs. Thank you for all your contributions.

@MichaelCurrin
Copy link
Contributor Author

PR added. Please review 👀

@jekyllbot jekyllbot removed the stale label Aug 2, 2021
@jekyll jekyll locked and limited conversation to collaborators Jan 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants