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

standard library not aligned #65

Open
klag opened this issue Mar 20, 2021 · 11 comments
Open

standard library not aligned #65

klag opened this issue Mar 20, 2021 · 11 comments
Assignees
Labels

Comments

@klag
Copy link
Member

klag commented Mar 20, 2021

it seems that the standard library into the documentation is not aligned with the actual one in the repo.

ex: RuntimeService

@fmontesi
Copy link
Member

Huh.. @xiroV, @thesave, and @bmaschio, could you have a look?

@thesave
Copy link
Member

thesave commented Mar 22, 2021

I don't remember if we generate it automatically anymore (once we did, but IIRC an update broke the generator).
If @bmaschio and @xiroV are available, we can set a meeting and try to tackle this.
Let me know :)

@klag
Copy link
Member Author

klag commented May 18, 2021

@thesave what about this issue? It seems it still persists

@thesave
Copy link
Member

thesave commented May 18, 2021

I think this and #66 and #62 are all related.
However, I do not know how we now generate the docs for the standard library after we moved to the new system.
@bmaschio, @xiroV do you have a pointer to that? Do we use joliedoc?

@fmontesi
Copy link
Member

fmontesi commented May 18, 2021 via email

@mwallnoefer
Copy link
Member

This continues to be an issue, e.g. als the fmt call in StringUtils is missing.

@mwallnoefer
Copy link
Member

Also MetaParser continues to not exist as a package and still needs to be included over import "metarender.iol" (and the service is called MetaRender and not Parser).

@klag
Copy link
Member Author

klag commented May 13, 2024

At the moment, metaservice is not delivered as a package, I think it is very useful to have it, also because some tools like jolier exploits it for working. @fmontesi wanted to refactor it, but I don't know if this activity is completed or not. I think that if the refactoring is not ready, we can publish metaservice as a package by now.

@fmontesi
Copy link
Member

@kicito I think you're the last one who looked at the problem of generating the documentation for the standard library. Was there any progress there?

In any case, we have the problem of updating the documentation website whenever I release a new version of Jolie. So, probably, the best choice is that the DevOps pipeline for Jolie releases (from github.com/jolie/jolie) also somehow updates the website's documentation for the right version. @kicito @mwallnoefer @klag what do you think? Or do you have other ideas?

@klag @mwallnoefer Regarding metaservice, it's already included. You're probably thinking of metajolie and metarender. It's going to be a while before we have a good solution where the Java and Jolie implementations of Jolie code representations are kept in sync, because of interesting technical issues. The new jolie2java is part of the solution but we'll need more features (more type primitives, for instance). So I think that, in the meantime, we should just copy metajolie and metarender from include to packages. @klag will you do the honours? You're the one who uses them so you're the one in the best position to check that they work by import after the change.

@klag
Copy link
Member Author

klag commented May 13, 2024

Yes I can do. In the meanwhile I am refactoring jolier, I'll do alltogether

@kicito
Copy link
Contributor

kicito commented May 14, 2024

I should have time to address this issue related to generating documentation for the standard library from this week. I'm unsure if joliedoc will be compatible with the new syntax, but updating the code should be straightforward. I agree that it should be a GitHub action from the main repository jolie/jolie, which builds the HTML and packs it into an artifact. This would then trigger jolie/doc and update the content.

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

No branches or pull requests

6 participants