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

How to help and timeframe for first release? #6

Open
lightglitch opened this issue Feb 19, 2020 · 2 comments
Open

How to help and timeframe for first release? #6

lightglitch opened this issue Feb 19, 2020 · 2 comments
Labels
To Discuss The core team has to decide if this will be implemented

Comments

@lightglitch
Copy link

I'm interested in this bundle (mainly in the API for getting content, not react part for now), so instead on developing one from scratch how can I help? Do you have a list of tasks/todos?

I see that the website controller is not in the routes configuration, what arguments are expected?

@alexander-schranz
Copy link
Member

@lightglitch the website controller will have no route. It is the controller you will use in your template.

https://github.com/sulu/skeleton/blob/e6fded803d20e3e03e9ceb9b5e1fa15330928176/config/templates/pages/default.xml#L9

If you have a page /en/example the url /en/example.json will return you the headless data.

See also following graphic how it works:

Headless - Rendering Process

Basically if you directly call /en/example we do not call /en/example.json as we write directly the data into the DOM and render it but all future requests will just call the .json of the pages you navigate to.

Follow the installation process on the README.md and please give us feedback how it works for you. Currently as you see in the issue content resolvers are missing and docs how it works, but it would be create to have feedback from the community how it works for you.

@niklasnatter
Copy link
Contributor

niklasnatter commented Feb 25, 2020

Right now, the the timeframe for the first stable release heavily depends on external feedback. We are using the bundle in production and it feels very stable, but there might be edge cases that our use-case does not cover. Furthermore, as described in #3, the bundle does not cover every content-type right now.

If you want to support the development of the bundle, i see two ways to do so right now:

  • Test the bundle in your project and give us feedback if it works for your use-case
  • Implement the missing resolvers documented in Missing ContentType resolver #3

@wachterjohannes wachterjohannes added the To Discuss The core team has to decide if this will be implemented label Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
To Discuss The core team has to decide if this will be implemented
Projects
None yet
Development

No branches or pull requests

4 participants