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

fix: Update github actions and readme #12

Merged
merged 1 commit into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ jobs:
run: pip install --upgrade ruff
- name: Run ruff
run: |
ruff djangocms_rest
ruff tests
ruff check djangocms_rest
ruff check tests
2 changes: 1 addition & 1 deletion .github/workflows/publish-to-live-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/djangocms-text
url: https://pypi.org/p/djangocms-rest
permissions:
id-token: write
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-to-test-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: test
url: https://test.pypi.org/p/djangocms-text
url: https://test.pypi.org/p/djangocms-rest
permissions:
id-token: write
steps:
Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@
djangocms-rest enables frontend projects to consume django CMS content through a browseable
read-only, REST/JSON API. It is based on the django rest framework (DRF).

For the following topics please see the ../README.md
- installation and setup instructions
- questions and support options
- collaboration and contributions to this project

## What is headless mode?

A Headless CMS (Content Management System) is a backend-only content management system that provides
Expand Down Expand Up @@ -103,7 +98,7 @@ can be serialized.

Yes, djangocms-text has both HTML blob and structured JSON support for rich text.

URLs to other CMS objects are dynamic, in the form of `cms.object-name:<uid>`, for example
URLs to other CMS objects are dynamic, in the form of `<app-name>.<object-name>:<uid>`, for example
`cms.page:2`. The frontend can then use this to resolve the object and create the appropriate URLs
to the object's frontend representation.

Expand All @@ -124,7 +119,7 @@ content available via the REST API.
Install using pip:

```bash
pip install git+https://github.com/fsbraun/djangocms_rest@main
pip install git+https://github.com/fsbraun/djangocms-rest@main
```

Update your `INSTALLED_APPS` setting:
Expand Down
1 change: 1 addition & 0 deletions tests/test_rendering.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
class RESTTestCase(CMSTestCase):
prefix = "http://testserver"


class RenderingTestCase(RESTTestCase):
def _create_pages(self, page_list, parent=None):
new_pages = [create_page(
Expand Down