Skip to content
This repository has been archived by the owner on Jun 25, 2021. It is now read-only.

Tutorials needed #1

Open
Markus-MfN opened this issue Dec 15, 2017 · 5 comments
Open

Tutorials needed #1

Markus-MfN opened this issue Dec 15, 2017 · 5 comments

Comments

@Markus-MfN
Copy link

This documentation is just an introduction or a very basic demo.

What is missing

  • Basic explanation and examples on how components and go~mus instance work together. Where are configuration options stored? How to define for instance what kind of tickets are available?

  • More complex use cases and explained code examples to show how to use components in a customized way.

  • Use cases and explained code examples using sub level components.

Page "Getting Started"

  • Demo code does not work anymore if I set domain to my custom domain in _gommusOption.

  • Setting options='{"types": ["day"]}' in step 4. seems to have no effect.

@douglasward
Copy link
Contributor

Hi @Markus-MfN, thank you for opening an issue!

You are quite correct. We know that the current documentation is lacking in a lot of these areas and we are working hard to get this done right in the next major release scheduled for sometime in January.

We aim to have a tutorials section (learning-orientated) and a how-to section (goal-oriented) to help span the gap to the more "reference" style documentation at the moment. These would be similar in style to the current "Getting Started" documentation. I will keep you up to date on the progress with this, and will hopefully be able to provide a link to the open source repository soon.

Demo code does not work anymore if I set domain to my custom domain in _gommusOption.

I imagine this is because the instance does not have the relevant data needed for the ticket component to work. For this you will need to contact your project manager from Giant Monkey through MfN.

Setting options='{"types": ["day"]}' in step 4. seems to have no effect.

Sorry about that, there was unfortunately a mistake in the documentation: day should actually be normal. I have fixed the documentation for the ticket options this morning.

@Markus-MfN
Copy link
Author

Markus-MfN commented Jan 12, 2018

Sorry about that, there was unfortunately a mistake in the documentation: day should actually be normal. I have fixed the documentation for the ticket options this morning.

Thank you @douglasward , now it has an effect on the calendar. But this should also be fixed at https://giantmonkey.github.io/gomus-components-doc/additional-documentation/getting-started.html

@Markus-MfN
Copy link
Author

With types set to normal the starting time defaults to 10:00. How can this be configured? How to have no starting time?

@douglasward
Copy link
Contributor

@Markus-MfN thank you for spotting that, the getting-started documentation is now fixed.

With types set to normal the starting time defaults to 10:00. How can this be configured? How to have no starting time?

Unfortunately this is not possible at the moment, but it will be possible in the next major release.

@douglasward
Copy link
Contributor

I will keep you up to date on the progress with this, and will hopefully be able to provide a link to the open source repository soon.

Sorry for the silence here, unfortunately the development of the new major version got pushed back a bit. We are now actively working on it again, so you should see some progress in the coming weeks.

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

No branches or pull requests

2 participants