plone / plone/documentation

Include diazo documentation in Classic backend documentation

Open
#2,044 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

43 lvl: complex
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

Links of affected pages in Plone Documentation, if any.

No response

Description

There is this documentation, which I don't know who serves and mantains https://docs.diazo.org/en/latest/ and I think it should belong (also) to the Plone documentation.

I see that the docs folder in the diazo repository are the same as in diazo.org, so I think we should integrate them pretty similar to the way we do with restapi.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the docs folder in the Diazo repository with the existing restapi integration in Plone Documentation. First identify how Classic backend documentation incorporates external documentation; done means the Diazo documentation is included and reachable from the Plone documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.