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

Static docs, Netlify, and PR branch deploy previews #2730

Closed
thompsongl opened this issue Jan 3, 2020 · 3 comments
Closed

Static docs, Netlify, and PR branch deploy previews #2730

thompsongl opened this issue Jan 3, 2020 · 3 comments
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries

Comments

@thompsongl
Copy link
Contributor

thompsongl commented Jan 3, 2020

Summary

Based on work done in #2577, I've got a PoC working that would allow us to:

  1. Build the EUI documentation as a static site
  2. Move our documentation to Netlify...
  3. which allows us to offload the docs build to the Netlify server...
  4. which allows us to automatically create doc deployments for all pull requests
  5. Remove the docs/ directory from source control
  6. Remove the build-docs script from the manual deployment process
  7. Enable Elastic Site Search
  8. Maintain versioned documentation sites (via subdomains; more research needed)

Assets

Working branch: master...thompsongl:static-docs
Deployed site: https://thompsongl-eui.netlify.com/
Netlify config:
Screen Shot 2020-01-03 at 9 21 28 AM

Discussion

@thompsongl thompsongl added documentation Issues or PRs that only affect documentation - will not need changelog entries discussion labels Jan 3, 2020
@thompsongl
Copy link
Contributor Author

It was a long break; just thought of one more thing: We'd need to tweak the release process a bit and/or use (potentially) GitHub actions to specify which tags/branches get deployed (aside from PR previews). By default, the master branch would always be the production deployment, which isn't how EUI releases work today. TBD here //cc @chandlerprall

@thompsongl
Copy link
Contributor Author

I'll likely close this issue in favor of another more appropriate one, but it's doubtful that Netlify and the approach outlined above will be our eventual direction. We're beginning work with Elastic infra to set up a more custom/configurable solution backed by Elastic.

@thompsongl
Copy link
Contributor Author

Closing this in favor of tracking in #2799

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries
Projects
None yet
Development

No branches or pull requests

1 participant