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

Docs are unusable. How to create/manage releases? #1821

Open
bploetz opened this issue May 10, 2023 · 0 comments
Open

Docs are unusable. How to create/manage releases? #1821

bploetz opened this issue May 10, 2023 · 0 comments

Comments

@bploetz
Copy link

bploetz commented May 10, 2023

I'm sorry, but the documentation for contentful-management.js is just completely unusable. The main page says:

You can start by looking at the top level contentfulManagement namespace........

There is no clickable contentfulManagement link anywhere in the docs. Where the heck do I find this?

The ContentfulClientAPI namespace defines the methods at the Client level which allow you to create and get spaces.

Ditto.

The ContentfulSpaceAPI namespace defines the methods at the Space level which allow you to create and get entries, assets, content types and other possible entities.

Ditto.

The Entry, Asset and ContentType namespaces show you the instance methods you can use on each of these entities, once you retrieve them from the server.

Ditto.

These things may in fact exist in the documentation, but there's no obvious way of how to find them!

Compare this to the content delivery library docs (https://contentful.github.io/contentful.js/contentful/10.2.0/). Which has a nice simple Overview section and then calls out directly exactly what you can do with the SDK:

Screenshot 2023-05-10 at 4 56 05 PM

Something like this is missing from the contentful-management SDK docs.

With that context, I can't for the life of me figure out how to create a Release using the contentful-management SDK, and then how to get/manage existing releases. Can someone point me in the right direction?

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

No branches or pull requests

1 participant