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

feat(other): include working vuepress for documentation automation #6836

Merged

Conversation

mahula
Copy link
Contributor

@mahula mahula commented Nov 17, 2023

🍰 Pullrequest

For the automated documentation deployment to docs.ocelot.social add a working vuepress configuration.

Todo

  • logo and favicon
  • generate sidebar menu from SUMMARY.md
  • TOC on each page's right side
  • tabs
  • fix image links
  • document documentation deployment

Issues

@mahula mahula self-assigned this Nov 17, 2023
@mahula mahula added docu Improvements or additions to documentation feature devops labels Nov 17, 2023
@mahula mahula marked this pull request as draft November 17, 2023 21:06
@mahula mahula changed the title fature(): add automated documentation deployment workflow feat(doc): add automated documentation deployment workflow Nov 17, 2023
@mahula mahula changed the title feat(doc): add automated documentation deployment workflow feat(other): add automated documentation deployment workflow Nov 17, 2023
Copy link
Member

@Tirokk Tirokk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment out the markdown section Error Reporting with subsection Self-hosted Sentry which triggers the error, because we don't use Sentry at the moment:

=========================> MARKDOWN LINK CHECK <=========================

  ERROR: 1 dead links found in ./deployment/src/kubernetes/README.md !
  [✖] ../templates/configmap.template.yaml → Status: 400

=========================================================================

Copy link
Member

@Tirokk Tirokk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool @mahula 😍

Great that you cared for this nice approach!

I have some hints and questions.

.github/workflows/check-documentation.yml Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
deployment/README.md Show resolved Hide resolved
deployment/deployment.md Show resolved Hide resolved
deployment/src/kubernetes/DigitalOcean.md Show resolved Hide resolved
deployment/src/kubernetes/README.md Show resolved Hide resolved
deployment/src/kubernetes/README.md Show resolved Hide resolved
deployment/src/kubernetes/README.md Show resolved Hide resolved
webapp/README.md Show resolved Hide resolved
@mahula
Copy link
Contributor Author

mahula commented Nov 24, 2023

Comment out the markdown section Error Reporting with subsection Self-hosted Sentry which triggers the error, because we don't use Sentry at the moment:

=========================> MARKDOWN LINK CHECK <=========================

  ERROR: 1 dead links found in ./deployment/src/kubernetes/README.md !
  [✖] ../templates/configmap.template.yaml → Status: 400

=========================================================================

Sure. Done in 4184ad1.

@mahula mahula closed this Nov 24, 2023
@mahula mahula reopened this Nov 24, 2023
@mahula mahula requested a review from Tirokk November 24, 2023 15:45
@mahula mahula mentioned this pull request Nov 24, 2023
9 tasks
Tirokk
Tirokk previously approved these changes Nov 24, 2023
Copy link
Member

@Tirokk Tirokk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice @mahula 😍
🙏🏼

I'm very happy it's done this way 🚀🚀🚀🌟💫💫

mahula and others added 5 commits November 29, 2023 11:48
…ry' of github.com:Ocelot-Social-Community/Ocelot-Social into 6866-remove-temp-(x.)ocelot.social-links

# Conflicts:
#	README.md
…p-(x.)ocelot.social-links

docs(other): remove temp `*.ocelot.social` links
@mahula mahula requested a review from Tirokk November 29, 2023 14:56
Copy link
Member

@Tirokk Tirokk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve 🥰

@mahula mahula merged commit 63d0d2c into master Nov 29, 2023
26 checks passed
@mahula mahula deleted the add-vuepress-action-with-root-directory-as-docs-directory branch November 29, 2023 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docu Improvements or additions to documentation feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants