diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a049593ad..f0707c835 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,8 +26,8 @@ #### Documentation - [ ] Updated build docs -- [ ] Updated editor guidelines (https://docs.google.com/document/d/1PAWccdQ4tfaZsrEWmpDhvP3GH5RRmBOARFVp4b-kje8/edit?usp=sharing) -- [ ] Updated field spec (https://docs.google.com/spreadsheets/d/1v1yqcSC54Vag4mxmTp8e6ZrnxITqzbjCA4A9XPQdXk8/edit?usp=sharing) +- [ ] Updated editor guidelines (See https://intranet.torchbox.com/torchbox-com-project-docs for the private link, for Torchbox employees only) +- [ ] Updated field spec (See https://intranet.torchbox.com/torchbox-com-project-docs for the private link, for Torchbox employees only) - [ ] Not required #### Browser testing diff --git a/docs/custom-features/contact.md b/docs/custom-features/contact.md index 0908fbec5..2e70f834f 100644 --- a/docs/custom-features/contact.md +++ b/docs/custom-features/contact.md @@ -34,4 +34,4 @@ The `tbx.people.ContactMixin` provides a mechanism for associating a specific co ???+ note - Please ensure that the [Editor's guide](https://docs.google.com/document/d/1PAWccdQ4tfaZsrEWmpDhvP3GH5RRmBOARFVp4b-kje8/edit?usp=sharing) is updated accordingly whenever any changes are made to this feature. + Please ensure that the Editors' guide is updated accordingly whenever any changes are made to this feature. A private link, for Torchbox employees only, can be found at https://intranet.torchbox.com/torchbox-com-project-docs. diff --git a/docs/custom-features/theme.md b/docs/custom-features/theme.md index 95938a19a..71d5b9675 100644 --- a/docs/custom-features/theme.md +++ b/docs/custom-features/theme.md @@ -27,4 +27,4 @@ The `tbx.core.utils.models.ColourThemeMixin` provides a mechanism for associatin ???+ note - Please ensure that the [Editor's guide](https://docs.google.com/document/d/1PAWccdQ4tfaZsrEWmpDhvP3GH5RRmBOARFVp4b-kje8/edit?usp=sharing) is updated accordingly whenever any changes are made to this feature. + Please ensure that the Editors' guide is updated accordingly whenever any changes are made to this feature. A private link, for Torchbox employees only, can be found at https://intranet.torchbox.com/torchbox-com-project-docs. diff --git a/docs/data-import.md b/docs/data-import.md index a55be6f27..2495ba619 100644 --- a/docs/data-import.md +++ b/docs/data-import.md @@ -4,7 +4,7 @@ When the current iteration of the site was built (January 2024) we needed to kee We kept the model code for these page types, but regenerated the migrations from scratch. -The process of importing the data (via `dumpdata` and `loaddata`) is described in the [annexe of the tech spec](https://docs.google.com/document/d/10ffo_nP2NqZ7K0rM3V2pP2JRQPD561FtjodlhiwnBrg/edit#heading=h.z5yppi5irclb) +The process of importing the data (via `dumpdata` and `loaddata`) is described in the annexe of the tech spec. You can find a private link, for Torchbox employees only, at https://intranet.torchbox.com/torchbox-com-project-docs. Streamfield data that did not match with our new definitions had data migrations applied: diff --git a/docs/external-docs.md b/docs/external-docs.md index 2779ae305..3b33fdc12 100644 --- a/docs/external-docs.md +++ b/docs/external-docs.md @@ -1,6 +1,8 @@ #External documentation for the project -- [Technical spec](https://docs.google.com/document/d/10ffo_nP2NqZ7K0rM3V2pP2JRQPD561FtjodlhiwnBrg/edit?usp=sharing) -- [Editor guidelines](https://docs.google.com/document/d/1PAWccdQ4tfaZsrEWmpDhvP3GH5RRmBOARFVp4b-kje8/edit?usp=sharing) -- [Field spec](https://docs.google.com/spreadsheets/d/1v1yqcSC54Vag4mxmTp8e6ZrnxITqzbjCA4A9XPQdXk8/edit?usp=sharing) -- [Decisions log](https://docs.google.com/spreadsheets/d/1W8g3N8VFVo3jpRYzY-HpitYloJJVpOG5-WDikvNqGKk/edit?usp=sharing) (Includes technical as well as project-related decisions) +These documents are not publicly available as they contain private information, intended only for Torchbox employees. Links can be found at https://intranet.torchbox.com/torchbox-com-project-docs. + +- Technical spec +- Editor guidelines +- Field spec +- Decisions log (Includes technical as well as project-related decisions) diff --git a/docs/general-principles.md b/docs/general-principles.md index beb3ef6b3..145ae4e06 100644 --- a/docs/general-principles.md +++ b/docs/general-principles.md @@ -16,7 +16,7 @@ On the previous torchbox.com build we found that some page types were too inflex ## Clear editor guidelines -We have created a set of editor guidelines at https://docs.google.com/document/d/1PAWccdQ4tfaZsrEWmpDhvP3GH5RRmBOARFVp4b-kje8/edit?usp=sharing. This should be updated with information on accessibility, image processing, image formats and content authoring. We have QA reminders in the merge request template and the ticket template to update this document when new work is done. +We have created a set of editor guidelines. This should be updated with information on accessibility, image processing, image formats and content authoring. We have QA reminders in the merge request template and the ticket template to update this document when new work is done. A private link, for Torchbox employees only, can be found at https://intranet.torchbox.com/torchbox-com-project-docs. ## Good documentation of both front-end and back-end