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.

Sign up for GitHub

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

Jump to bottom

Implement Documentation Page #9

Merged
merged 19 commits into from
Oct 28, 2022
Merged

Implement Documentation Page #9

merged 19 commits into from
Oct 28, 2022

Conversation

ChrisHinchey
Copy link
Contributor

@ChrisHinchey ChrisHinchey commented Sep 26, 2022 •
edited

Goal: Add documentation features and functionality to the SAF site.

  • Create graphql query to obtain documentation data from strapi
  • Properly display rich text content requested from strapi
  • Add subsection navigation to jump between desired subsections
  • Add previous and next page functionality to browse through subsections
  • Implement index page for documentation
  • Create graphql query for index page
  • Add "On this page" functionality to jump to headers in the documentation subsection
  • Add mobile navigation for jumping between subsections
  • Move subsection navigation to separate component to be used in mobile navigation
  • Separate content into its own component to improve rendering and code readability
  • Sort and display sections by order_id

Related:

@ChrisHinchey
initial commit for documentation
808e6e8 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Added previous page and next page functionality
21762f6 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Removed unused graphql file
c1273c3 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Cleaned up documentation code
05fb8c5 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey ChrisHinchey added the enhancement New feature or request label Sep 26, 2022
@ChrisHinchey ChrisHinchey self-assigned this Sep 26, 2022
@netlify
Copy link

netlify bot commented Sep 26, 2022 •
edited

✅ Deploy Preview for mitre-saf-v2 ready!

Name Link
🔨 Latest commit cc63c17
🔍 Latest deploy log https://app.netlify.com/sites/mitre-saf-v2/deploys/635c5fa11b4c2800086f8348
😎 Deploy Preview https://deploy-preview-9--mitre-saf-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ChrisHinchey
Cleaned up code to fix build error
1cfb863 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Updated handeling of index page for documentation
b050664 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Added mobile navigation modal
d1b0d7f 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Create documentation navigation component and current page navigation
5293771 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Split coded into seperate components and Added sorting by order_id in…
5879ac6 
… graphql queries

Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Minor display imporvement
71eb647 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey ChrisHinchey added the page: documentation Improvements or additions to documentation label Oct 14, 2022
ChrisHinchey and others added 5 commits October 17, 2022 13:27
@ChrisHinchey
Removed uneeded queires from branch to fix build error
ac8b19d 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Fixed styling issues
4bed653 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Styling changes
79b1c00 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Requested styling changes
73e08ff 
Signed-off-by: Christopher Hinchey <chinchey@mitre.org>
@ChrisHinchey
Removed extra function
de0401b
Amndeep7
Amndeep7 requested changes Oct 26, 2022
View reviewed changes
components/DocumentationPageNavigation.vue Show resolved Hide resolved
components/Header.vue Show resolved Hide resolved
components/Header.vue Show resolved Hide resolved
components/Header.vue Show resolved Hide resolved
components/Header.vue Show resolved Hide resolved
components/DocumentationPageNavigation.vue Outdated Show resolved Hide resolved
components/DocumentationPageNavigation.vue Show resolved Hide resolved
pages/docs/index.vue Show resolved Hide resolved
pages/docs/[section].vue Show resolved Hide resolved
queries/getIndexDocumentation.gql Show resolved Hide resolved
This was referenced Oct 26, 2022
Closed
Closed
@ChrisHinchey ChrisHinchey merged commit a396fd1 into main Oct 28, 2022
@ChrisHinchey ChrisHinchey deleted the feature/documentation branch February 1, 2023 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Amndeep7 Amndeep7 Amndeep7 requested changes

Assignees

@ChrisHinchey ChrisHinchey

Labels
enhancement New feature or request page: documentation Improvements or additions to documentation
Projects
SAF Site
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ChrisHinchey @Amndeep7