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

Add content type intro and FTI reference #1498

Merged
merged 10 commits into from
May 16, 2023
Merged

Add content type intro and FTI reference #1498

merged 10 commits into from
May 16, 2023

Conversation

davisagli
Copy link
Sponsor Member

Beginning of work on #1303

This has an intro adapted from https://github.com/plone/training/blob/main/docs/mastering-plone/dexterity.md (but trying to avoid tutorial-style content)

And a reference for the properties that can be set on an FTI to define a content type, inspired by https://github.com/plone/documentation/blob/6.0/plone.app.dexterity/schema-driven-types.md but mostly written from scratch to make sure we're covering all the properties.

@netlify
Copy link

netlify bot commented May 15, 2023

Deploy Preview for 6-docs-plone-org ready!

Name Link
🔨 Latest commit 8a1ab56
🔍 Latest deploy log https://app.netlify.com/sites/6-docs-plone-org/deploys/6462f91cffe6ce00082fdfc2
😎 Deploy Preview https://deploy-preview-1498--6-docs-plone-org.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly MyST syntax changes, and a few style changes.

docs/backend/content-types/index.md Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@davisagli
Copy link
Sponsor Member Author

@stevepiercy The changes to use {doc} links don't seem to be correct:

/Users/davisagli/Plone/documentation/docs/backend/content-types/index.md:154: WARNING: unknown document: portal-actions
/Users/davisagli/Plone/documentation/docs/backend/content-types/index.md:167: WARNING: unknown document: behaviors
/Users/davisagli/Plone/documentation/docs/backend/content-types/index.md:221: WARNING: unknown document: icons

@stevepiercy
Copy link
Contributor

stevepiercy commented May 15, 2023

@stevepiercy The changes to use {doc} links don't seem to be correct:

/Users/davisagli/Plone/documentation/docs/backend/content-types/index.md:154: WARNING: unknown document: portal-actions
/Users/davisagli/Plone/documentation/docs/backend/content-types/index.md:167: WARNING: unknown document: behaviors
/Users/davisagli/Plone/documentation/docs/backend/content-types/index.md:221: WARNING: unknown document: icons

Ah, the path needs to be adjusted, as {doc} resolves to the current directory. I typically prefer using root-relative paths to disambiguate.

@stevepiercy
Copy link
Contributor

The todos in definitions are also messed up. That might be because of a nested backtick fence from the parent glossary, but should be resolved when conversion is complete.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one stray space, and still wonky todos (see updated comment), and it's good to go.

Yeah, there should be only one glossary. Lists are lists. There is slightly different HTML which can be used for CSS, <dl class="glossary"> versus <dl class="simple myst">.

docs/backend/content-types/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a 🛌 and ☕ , and noticed a couple more things. What do you think?

docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
docs/backend/content-types/index.md Outdated Show resolved Hide resolved
@stevepiercy
Copy link
Contributor

FTR, I don't know what I missed on the first pass, but this test works for me:

`view_methods2`
:   ```{todo}
    some todo
    ```

Screen Shot 2023-05-15 at 4 00 41 PM

We did away with the TODO, but now we have a working example.

@stevepiercy
Copy link
Contributor

@davisagli just a heads up to pull my commit a5647c3 before pushing additional work.

Co-authored-by: Steve Piercy <web@stevepiercy.com>
@stevepiercy
Copy link
Contributor

@davisagli I'll let you merge, assuming you might want to get another sprinter to look it over.

@davisagli
Copy link
Sponsor Member Author

@stevepiercy Jens already reviewed it, so I'll go ahead.

@davisagli davisagli merged commit 6cb6fec into 6.0 May 16, 2023
7 checks passed
@davisagli davisagli deleted the content-types branch May 16, 2023 05:43
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

Successfully merging this pull request may close these issues.

None yet

3 participants