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

Move UI Framework docs to elastic.co #9457

Closed
4 tasks
cjcenizal opened this issue Dec 13, 2016 · 7 comments
Closed
4 tasks

Move UI Framework docs to elastic.co #9457

cjcenizal opened this issue Dec 13, 2016 · 7 comments
Assignees
Labels
release_note:enhancement Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins.

Comments

@cjcenizal
Copy link
Contributor

cjcenizal commented Dec 13, 2016

Originally from discussion within #8867 (comment).

As a company, we want all docs to be on elastic.co (both for users and contributors). This would, for example, apply to the UI Framework docs and future documentation for the Kibana Plugin API.

I think we can do this with the following steps:

  • Talk with our infra team to make a server available.
  • Update Jenkins to deploy to this server when master changes.
  • Improve landing page to provide a better introduction to the UI Framework.
  • Improve navigation to provide a brief summary of each component.

Per @tbragin:

@cjcenizal @epixa @debadair I think it's worthwhile noting that we don't yet have a natural place to put Kibana developer-facing docs in the current Kibana guide. We have a plugin users section (installing/updating/removing plugins): https://www.elastic.co/guide/en/kibana/current/kibana-plugins.html

So this feels like either a net-new section in existing Kibana docs (the way Logstash docs do it) or a whole new "book" for plugin developers (the way Elasticsearch does it).

@cjcenizal
Copy link
Contributor Author

cjcenizal commented Dec 19, 2016

Just a note that GitHub has some pretty nice docs for their CSS framework, Primer.

@epixa
Copy link
Contributor

epixa commented Dec 19, 2016

Last week I added a section to the docs called "Contributing to Kibana", so I think that would be the logic place to link these docs.

@uboness
Copy link

uboness commented Apr 24, 2017

@cjcenizal can part of this work be to remove all server components we have there? There's no real need for it and it'll make things much simpler for hosting

@cjcenizal
Copy link
Contributor Author

@uboness Which server components are you referring to?

@uboness
Copy link

uboness commented Apr 24, 2017

last time I checked (and it was quite a while ago :)) you had to run a server to access the UI framework docs. If it's no longer there - 👍 and forget about my comments

@cjcenizal
Copy link
Contributor Author

Ah, I see. Yes, you still run a server to live-update your browser as you're developing, but this is only used during the dev process. For deployment, we'll only need to host some static assets.

@cjcenizal
Copy link
Contributor Author

Closing this as EUI is published via GitHub pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:enhancement Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins.
Projects
None yet
Development

No branches or pull requests

3 participants