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

Improve documentation for brjs release process and micro lib upgrades #1642

Open
thecapdan opened this issue Jan 25, 2016 · 4 comments
Open

Comments

@thecapdan
Copy link
Contributor

We need to document:

  1. the manual step for upgrading our js doc when we release (see https://github.com/BladeRunnerJS/brjs-api-docs)
  2. upgrading our micro libraries.
@thecapdan thecapdan added this to the Current Focus milestone Jan 25, 2016
@dchambers
Copy link
Contributor

@thecapdan, as for why the documentation isn't working for 1.2.0 and 1.3.0, this is because GitHub now fails to build our docs. I was able to build fine locally (using jekyll build --safe), so I did an empty commit in the hopes of getting an email containing an error message to diagnose the problem, but I just got this instead:

The page build failed with the following error:

Page build failed. For more information, see https://help.github.com/articles/troubleshooting-github-pages-build-failures.

If you have any questions you can contact us by replying to this email.

This means that it's one of the Generic Failures they list:

  1. Push from user with unverified email address (given that Andy also tried for a re-build by re-pushing it's unlikely to be that).
  2. Deploy key used for push (not sure how this is different to number 1).
  3. Use of unsupported plugin (I've confirmed the failing commit did not introduce any new plug-ins).
  4. Size limits (It's probably this because GitHub repos have a soft 1GB size limit, and although this repo is currently only 678MB, it becomes double that size after running the Jekyll build).

So, it looks like we probably need to start removing some of the older documentation. Given that we don't even link to documentation prior to 0.9 then stuff prior to that would seem like a good candidate for removal.

@thecapdan, are you happy with me removing all API docs prior to 0.9?

@dchambers
Copy link
Contributor

My mistake, there's actually no documentation earlier than 0.9. Here are the relevant CaplinTrader releases that should probably inform this decision:

  • CaplinTrader 4.0.0 (BRJS 0.11, 20th of August 2014)
  • CaplinTrader 4.0.1 (BRJS 0.14.3, 15th of December 2014)

Deleting only 0.9 and 0.10 may work, but not for long, so it may make sense to delete everything before 0.14.3, that being 0.9, 0.10, 0.11, 0.12, 0.13, 0.14, 0.14.1 & 0.14.2?

@dchambers
Copy link
Contributor

Deleting only 0.9 and 0.10 may work, but not for long, so it may make sense to delete everything before 0.14.3, that being 0.9, 0.10, 0.11, 0.12, 0.13, 0.14, 0.14.1 & 0.14.2?

@thecapdan?

@thecapdan
Copy link
Contributor Author

Lets delete everything before 0.14.2. Previous versions of the docs linked to versions of ct are saved on the other site anyway

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

2 participants