Skip to content

Commit 284a9db

Browse files
Added related content to backend docs (#2032)
* Added related content to backend docs * Added related content to classic ui docs * Apply suggestions from code review Co-authored-by: Steve Piercy <web@stevepiercy.com> * Remove related content section from zodb.md * Remove content types from documentation Removed duplicate related content references. * changed see also label to doc --------- Co-authored-by: Steve Piercy <web@stevepiercy.com>
1 parent 568d263 commit 284a9db

File tree

8 files changed

+48
-1
lines changed

8 files changed

+48
-1
lines changed

docs/backend/indexing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,3 +226,7 @@ Indexes the object path, such as `/news/news-item-1`.
226226
## `Subject` (`KeywordIndex`)
227227

228228
Indexes the `Subject` field which contains a list of object categories.
229+
230+
## Related content
231+
232+
- {doc}`/backend/search`

docs/backend/search.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,6 @@ Help us [Migrate content from v5 "Queries, Search And Indexing" #1730](https://g
3535

3636
## Querystring
3737

38+
## Related content
39+
40+
- {doc}`/backend/indexing`

docs/backend/subscribers.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,3 +170,9 @@ The DCWorkflow events are low-level events that can tell you a lot about the pre
170170
`zope.processlifetime.IProcessStarting` is triggered after the component registry has been loaded and Zope is starting up.
171171

172172
`zope.processlifetime.IDatabaseOpened` is triggered after the main ZODB database has been opened.
173+
174+
## Related content
175+
176+
- {doc}`/backend/behaviors`
177+
- {doc}`/backend/content-types/index`
178+

docs/backend/traversal-acquisition.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If not explicitly given, at the end a default view is looked up.
3030
This can be a registered page template, a callable view class, or a REST API endpoint.
3131

3232
```{seealso}
33-
{ref}`Chapter Views <classic-ui-views-label>`
33+
{doc}`/classic-ui/views`
3434
```
3535

3636
In code, traversal can be achieved by using the `restrictedTraverse` and `unrestrictedTraverse` methods of content objects.
@@ -87,3 +87,10 @@ For example, if object `A` contains object `B`, and object `A` has a property `x
8787
- About traversal: [Zope Developers Handbook, Chapter Object Publishing](https://zope.readthedocs.io/en/latest/zdgbook/ObjectPublishing.html)
8888
- About acquisition: [Zope Developers Handbook, Chapter Acquisition](https://zope.readthedocs.io/en/latest/zdgbook/Acquisition.html)
8989
```
90+
91+
## Related content
92+
93+
- {doc}`/backend/portal-actions`
94+
- {doc}`/backend/security`
95+
- {doc}`/classic-ui/views`
96+

docs/classic-ui/forms.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,3 +273,9 @@ In your `configure.zcml`:
273273

274274
</configure>
275275
```
276+
277+
## Related content
278+
279+
- {doc}`/backend/fields`
280+
- {doc}`/backend/schemas`
281+
- {doc}`/backend/widgets`

docs/classic-ui/layers.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,3 +314,10 @@ from zope.interface import directlyProvides
314314

315315
directlyProvides(self.portal.REQUEST, IThemeLayer)
316316
```
317+
318+
## Related content
319+
320+
- {doc}`/classic-ui/theming/index`
321+
- {doc}`/classic-ui/theming/create-add-on`
322+
- {doc}`/classic-ui/templates`
323+
- {doc}`/classic-ui/viewlets`

docs/classic-ui/viewlets.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,3 +1048,11 @@ def fix_tinymce_viewlets(site):
10481048
hidden = (x for x in hidden if x != "tinymce.configuration")
10491049
storage.setHidden(manager, skinname, hidden)
10501050
```
1051+
1052+
## Related content
1053+
1054+
- {doc}`/classic-ui/layers`
1055+
- {doc}`/classic-ui/templates`
1056+
- {doc}`/classic-ui/views`
1057+
1058+

docs/classic-ui/views.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1121,3 +1121,9 @@ return self.obj.absolute_url() # Acquistion chain messed up, getPhysicalPath()
11211121
```
11221122
11231123
One workaround to avoid this mess is to use `aq_inner` when accessing `self.obj` values, as described in [Dealing with view implicit acquisition problems in Plone](https://stackoverflow.com/questions/11753940/dealing-with-view-implicit-acquisition-problems-in-plone/11755348#11755348).
1124+
1125+
## Related content
1126+
1127+
- {doc}`/classic-ui/layers`
1128+
- {doc}`/classic-ui/templates`
1129+
- {doc}`/classic-ui/viewlets`

0 commit comments

Comments
 (0)