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

Pull documentation through into docs.silverstripe.org #985

Closed
4 tasks
GuySartorelli opened this issue Jun 26, 2022 · 1 comment
Closed
4 tasks

Pull documentation through into docs.silverstripe.org #985

GuySartorelli opened this issue Jun 26, 2022 · 1 comment

Comments

@GuySartorelli
Copy link
Member

GuySartorelli commented Jun 26, 2022

Elemental blocks are effectively a first-class citizen in the Silverstripe CMS now - the documentation should be on the docs.silverstripe.org site.

Acceptance criteria

  • Documentation is (briefly) reviewed and improved or updated where necessary
    • Main focus is outdated docs, areas where callout blocks should be added, and updating URLs
    • Restructuring the docs is at the implementer's discretion
    • URLs to other dev docs should be relative paths for docs in this repo, and https://docs.silverstripe.org/en/developer_guides/model/data_model_and_orm/ style (note no version number) for other docs
    • API links must use [ClassName](api:FQCN) format
  • Dev docs sources-docs.js is updated to pull in docs from this site
  • userguide is not pulled into dev docs, but is still pulled into userhelp docs
  • Apply linting to documentation (see Move documentation linting to its own repository .github#206)

PRs

@GuySartorelli
Copy link
Member Author

PRs merged, reassigning to Steve to check it looks correct on the site

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

No branches or pull requests

2 participants