Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.
This repository was archived by the owner on Sep 28, 2022. It is now read-only.

Deploy scriptedforms server #241

Open
Open
Deploy scriptedforms server#241

Description

@robmarkcole
robmarkcole
opened on Apr 15, 2018

@SimonBiggs I love how when you run scriptedforms the docs interface launches:

image

I think it would be great to make it as simple as this for a user to deploy all of their own scriptedforms via a mini website, so I can just send my colleagues a single url and they can browse my forms. If it was just a case of organising forms into a folder structure, then running scriptedforms parent_directory to get the website that would be incredible.
Cheers

Activity

  1. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    I really like this idea. Maybe I should be fleshing this idea out first, then use this "website builder" to create the docs themselves...

  2. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    I originally dismissed your jekyll idea... but maybe to handle this side of things, that is the way to go...

  3. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    Have a think about what sort of control you would need.

    My thoughts are minimal control over page layout etc would be required. For this use case the best method for the creator really should just be forms inside a directory and then it creates a mini-website using it.

    ...That would mean Jekyll won't really be necessary, as I will set up the page layout + design using Angular. Page contents would still just be markdown files of course, probably just ScriptedForms to be exact.

  4. robmarkcole commented on Apr 15, 2018

    @robmarkcole
    robmarkcole
    on Apr 15, 2018
    CollaboratorAuthor

    Sounds good.
    Re control, I imagine I would have 1 server for personal scripts, and another for sharing with colleagues, so permissions wouldn't be an issue. If the shared server could also log traffic that would be useful

  5. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    Ahh when I said control I mean over page layout etc. If you don't mind not having much control/configurability then that makes the creation much simpler both for the form creator and for me making the system ...

  6. robmarkcole commented on Apr 15, 2018

    @robmarkcole
    robmarkcole
    on Apr 15, 2018
    CollaboratorAuthor

    Ok sure, I say keep it simple then. I presume that someone with web skills could write a wrapper around the basic page, if they wanted to add official logos, or embed within a corporate wiki structure?

    btw your idea of making the official docs using this approach would be neat and then serve as a good example in itself!

  7. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    Alright, well that puts this issue then as top priority. I need to do a bit more thinking about how best to implement it. If you have any more ideas/needs with respect to this let me know so that I can think about those also.

  8. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    How I've thought about implementing it, it would be quite rigid. It wouldn't be simple to change the layout without seriously digging deep. Not ideal.

    But you're right, this is a need. Maybe I could enable the use of jinja2 templates. That way someone could change that template to have control over the layout etc.

  9. SimonBiggs commented on Apr 15, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 15, 2018
    Owner

    @robmarkcole you mentioned a big benefit of this website idea is you could point to a directory and allow users to navigate through it.

    Could the solution be as simple as something like when you call scriptedforms from the command prompt there is an option --with-navigation you would write something like the following:

    scriptedforms --with-navigation 00-landing-page.form.md

    That would then open up the form called 00-landing-page.form.md, but with a difference, there would be a navigation panel to the left. That panel would provide links to all the forms within the directory. By default it would be alphabetical order, but by putting numbers in front of all the files you could control the display order...

  10. robmarkcole commented on Apr 16, 2018

    @robmarkcole
    robmarkcole
    on Apr 16, 2018
    CollaboratorAuthor

    @SimonBiggs that sounds like a good solution

  11. SimonBiggs commented on Apr 30, 2018

    @SimonBiggs
    SimonBiggs
    on Apr 30, 2018
    Owner

    @robmarkcole

    Okay, so I've been struggling with how to implement this. To create the docs I want to be able to create a form with a navigation panel, and I want it to no have the toolbar at the top.

    To achieve this, really what I need is some form configuration or metadata. Something like Jekyll's front matter might be perfect for this advanced use case.

    For example:

    ---
toolbar: false
navigation: true
---

# Heading

Rest of form ... etc ...

<observe-session-start>

```python
stuff = 'foo'
```

</observe-session-start>

    What do you think? Okay for this advanced case?

  12. robmarkcole commented on Apr 30, 2018

    @robmarkcole
    robmarkcole
    on Apr 30, 2018
    CollaboratorAuthor

    @SimonBiggs front matter looks good to me. Best to keep the yaml as simple as possible as I know from expereience on Home-Assistant that yaml is very sensitive to indentation/white-space etc.
    Cheers

  13. ankostis commented on Mar 7, 2019

    @ankostis
    ankostis
    on Mar 7, 2019

    I don't know if that's the right issue, but having the capability to launch a scriptedform from within a jupyter-notebook, would be more welcomed. That way, spending the usual effort to install and an maintain a jupyter server would give you a home for your forms for free.

  14. SimonBiggs commented on Mar 7, 2019

    @SimonBiggs
    SimonBiggs
    on Mar 7, 2019 via email
    Owner

  15. ankostis commented on Mar 8, 2019

    @ankostis
    ankostis
    on Mar 8, 2019

    I think issue #243 is about what i had in mind:
    instead of spending the time to have an easy-to-deploy standalone scriptedforms distribution, just make sure that it embeds flawlessly into any Jupyter-server installation, so the usual options for that piece of software apply: jupyter-hub, multi-user setup, security extensions, widgets, etc.

    Does that make sense?

  16. SimonBiggs commented on Mar 8, 2019

    @SimonBiggs
    SimonBiggs
    on Mar 8, 2019 via email
    Owner

  17. ankostis commented on Mar 8, 2019

    @ankostis
    ankostis
    on Mar 8, 2019

    Thanks!

    From the docs i got the impression that it is only possible to launch it from the command-line.

  18. SimonBiggs commented on Mar 8, 2019

    @SimonBiggs
    SimonBiggs
    on Mar 8, 2019 via email
    Owner
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions