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

Developer documentation #27

Closed
7 of 8 tasks
maxime-rainville opened this issue Nov 24, 2020 · 5 comments
Closed
7 of 8 tasks

Developer documentation #27

maxime-rainville opened this issue Nov 24, 2020 · 5 comments
Assignees

Comments

@maxime-rainville
Copy link

maxime-rainville commented Nov 24, 2020

Story

As a Developer I want to understand how the LinkField module work so that I can use it effectively in my own projects.

Acceptance criteria

  • All docs in the repo is moved to the official developer docs and removed from the repo.
  • A single link to tho official doc article is added to the LinkField Read Me
  • Changelog is updated to prominently call out this new feature.
  • Developer docs explains how to use links and link fields.
  • Developer docs explains how to create custom link types.
  • Developer docs explains how to render Links in templates and how to override the default template.
  • Developer link doc has been reviewed as a whole.
  • Add linkfield to supported modules list

Note

There will be a separate card for user help.

PRs

@DanielTate
Copy link

This should be higher priority. How do I use this field in my templates for example? There are no docs on this it seems.

@emteknetnz
Copy link
Member

Since this is an optional module dev docs should remain be in README.md, not doc.silverstripe.org

@GuySartorelli GuySartorelli self-assigned this Feb 14, 2024
@GuySartorelli
Copy link
Member

Regarding "All docs in the repo is moved to the official developer docs and removed from the repo.", I had a discussion on slack with Max about this.
Instead we will be moving the docs into the docs/en/ directory in the module, and having the developer docs site pull content from there (like userhelp pulls a bunch of its docs from other modules).

@emteknetnz
Copy link
Member

Assigning back to Guy to confirm that everything deployed correctly

@GuySartorelli
Copy link
Member

Docs site didn't break so that's a good sign lol.
We won't be able to check fully until we add a 4.0 branch fo linkfield and get the docs site to pull from 5.2 in developer docs.

@GuySartorelli GuySartorelli changed the title Dev docs Developer documentation Feb 26, 2024
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

No branches or pull requests

4 participants