572 move guidance pages into submit service

DilwoarH commented 3 weeks ago

What type of PR is this? (check all applicable)

[ ] Refactor
[x] Feature
[ ] Bug Fix
[ ] Optimization
[ ] Documentation Update

Description

Move guidance from main website to this repo

Related Tickets & Documents

Ticket Link
Related Issue #
Closes #572 #573

QA Instructions, Screenshots, Recordings

Nov-06-2024 12-01-27 pm

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

[ ] Yes
[ ] No, and this is why: please replace this line with details on why tests have not been included
[ ] I need help with writing tests

[optional] Are there any post deployment tasks we need to perform?

[optional] Are there any dependencies on other PRs or Work?

Summary by CodeRabbit

Release Notes

New Features
- Introduced a new guidance navigation section providing structured guidance for data providers.
- Added a sub-navigation component for improved navigation within the application.
- Launched several new guidance documents for local planning authorities on data preparation and compliance, including instructions on publishing data and maintaining data currency.
- Implemented a new service for checking data compliance against technical specifications.
Bug Fixes
- Updated hyperlinks in various templates to point to relative URLs for better navigation.
Documentation
- Added multiple Markdown files detailing specifications for various datasets, including article 4 directions, conservation areas, listed buildings, and tree preservation orders.
- Introduced a new layout template for guidance-related pages to enhance user experience.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request introduces several enhancements to the guidance system within the application. A new section, guidanceNavigation, is added to the configuration file, providing structured links to various guidance topics. Additionally, a new SCSS file for sub-navigation styles is created, and multiple Markdown files are introduced to serve as guidance documents for local planning authorities. The routing system is updated to include these new guidance pages, ensuring users can access them seamlessly within the service.

Changes

File Path	Change Summary
`config/default.yaml`	Added `guidanceNavigation` section with `title` and list of `items` for various guidance topics.
`src/assets/scss/components/_sub-navigation.scss`	Created styles for the sub-navigation component, defining multiple classes for layout and design.
`src/assets/scss/index.scss`	Added import statement for the new sub-navigation SCSS file.
`src/routes/guidance.js`	Introduced a new Express router for handling guidance-related routes with dynamic template rendering.
`src/serverSetup/routes.js`	Added route mapping for `/guidance` to the new guidance router.
`src/views/check/start.html`	Updated hyperlink to a relative URL for data specifications.
`src/views/components/sub-navigation.html`	Introduced a new sub-navigation component in HTML format.
`src/views/guidance/index.md`	Created a new Markdown file outlining a process for LPAs to provide data.
`src/views/guidance/keep-your-data-up-to-date.md`	Added guidance on the importance of updating data.
`src/views/guidance/publish-data-on-your-website.md`	Provided instructions for publishing data on websites.
`src/views/guidance/specifications/article-4-direction.md`	Introduced guidance for article 4 direction datasets.
`src/views/guidance/specifications/conservation-area.md`	Created guidance for conservation area data submission.
`src/views/guidance/specifications/design-code.md`	Added guidance for design code datasets.
`src/views/guidance/specifications/index.md`	Outlined requirements for publishing data on websites.
`src/views/guidance/specifications/listed-building.md`	Provided guidance for datasets related to listed buildings.
`src/views/guidance/specifications/tree-preservation-order.md`	Introduced guidance for tree preservation orders.
`src/views/guidance/try-check-publish-service.md`	Created an overview of an online service for checking data compliance.
`src/views/layouts/guidance.html`	Introduced a new layout template for guidance pages.
`src/views/organisations/get-started.html`	Updated hyperlink to a relative URL for data specifications.
`src/views/submit/start.html`	Updated hyperlinks from absolute to relative URLs for data specifications.

Assessment against linked issues

Objective	Addressed	Explanation
Move guidance pages into submit service (#572)	✅

Possibly related PRs

#593: The changes in this PR involve content modifications related to the check tool, which aligns with the guidance topics introduced in the main PR's guidanceNavigation section, enhancing the usability of the guidance provided.
#602: This PR updates the terminology on the 'get started' page to ensure consistency with the guidance language, which is relevant to the new guidance topics added in the main PR.

Suggested reviewers

rosado

Poem

🐇 In a world of planning, we hop and play,
With guidance so clear, we find our way.
From trees to buildings, our data's in sight,
With links to assist, we’ll do it right!
So gather your info, let’s publish with glee,
For a brighter tomorrow, together, you and me! 🌳📊

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Reviewing files that changed from the base of the PR and between e568382830c5c6e1a0e61ff4c4964ca089814101 and c5971b6ef946be4ce86b829cecd09b1c8bf6941b.

📒 Files selected for processing (2)

* `src/assets/scss/index.scss` (2 hunks) * `src/views/layouts/guidance.html` (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

* src/assets/scss/index.scss * src/views/layouts/guidance.html

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 2 weeks ago

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	66.4%	4007 / 6034
🔵	Statements	66.4%	4007 / 6034
🔵	Functions	66.15%	174 / 263
🔵	Branches	81.22%	476 / 586

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
src/routes/guidance.js	0%	0%	0%	0%	1-83
src/routes/schemas.js	100%	100%	100%	100%
src/serverSetup/nunjucks.js	83.33%	72.72%	100%	83.33%	35-36, 48-54, 62-64
src/serverSetup/routes.js	0%	0%	0%	0%	1-25

Generated in workflow #233 for commit c5971b6 by the Vitest Coverage Report Action

CharliePatterson commented 2 weeks ago

One small thing on this page: https://submit-pr-613.herokuapp.com/guidance/try-check-publish-service

The link to the check tool seems to redirect to the landing page:

Try the Check planning and housing data service.

DilwoarH commented 2 weeks ago

One small thing on this page: https://submit-pr-613.herokuapp.com/guidance/try-check-publish-service

The link to the check tool seems to redirect to the landing page:

Try the Check planning and housing data service.

done

digital-land / submit