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

Refine workflow and associated documentation #1914

Closed
3 tasks done
gemfarmer opened this issue Sep 28, 2016 · 6 comments
Closed
3 tasks done

Refine workflow and associated documentation #1914

gemfarmer opened this issue Sep 28, 2016 · 6 comments

Comments

@gemfarmer
Copy link
Contributor

gemfarmer commented Sep 28, 2016

  • refine server and build scripts
    • Currently site developers are either using the following commands to serve the project locally:
      • bundle exec jekyll serve: this does the trick, but is long, and rebuilds the jekyll-archives entirely, instead of incrementally.
      • ./serve: shorter, and removes the jekyll-archives gem to avoid building or rebuilding archives. This works great for development, but has the unfortunate side-effect of modifying the Gemfile.lock.
  • add/edit server and build script documentation. Even if there are multiple ways to run the site, there should only be one method documented.
  • add/refine contributing documentation
@gemfarmer gemfarmer self-assigned this Sep 28, 2016
@gemfarmer
Copy link
Contributor Author

After giving this a little more consideration, I think that jumpstarting the site differently in development vs CircleCI/production shouldn't be an issue as long as the documentation prevents us from overwriting the Gemfile.lock every PR.

@gboone @mugizico does that make sense to both of you?

@gemfarmer
Copy link
Contributor Author

We discussed forking the PR here for incremental jekyll archives builds instead of continuing to modify the build script.

cc @gboone

@gemfarmer
Copy link
Contributor Author

Started working on 18F version of Jekyll archives. So far it isn't speeding up regeneration.

@coreycaitlin
Copy link

Blocked: waiting for response from the plugin developer.

@gemfarmer
Copy link
Contributor Author

See #1849 for more info on why this is blocked

@coreycaitlin
Copy link

Closing this out — it's in much better shape! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants