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

[Documentation] "Develop" page #686

Open
2 tasks done
devtobi opened this issue Jan 9, 2025 · 0 comments
Open
2 tasks done

[Documentation] "Develop" page #686

devtobi opened this issue Jan 9, 2025 · 0 comments
Labels
Priority: High The issue contains work with high priority. Type: Documentation The issue contains work for the documentation
Milestone

Comments

@devtobi
Copy link
Member

devtobi commented Jan 9, 2025

Relevant documentation

Other

Problem description (optional)

No response

Desired solution

We want to provide a information page on how to develop using the refarch templates. This .e.g includes:

  • Explaination of the development docker stack and include links to directly land on development UIs
  • Short overview of included CI/CD configurations (workflows and actions) => reference external documentation
  • Explanation of CODEOWNERS file
  • Explain tooling for Pull Requests (CodeRabbit configuration, CodeQL, Dependency Review, suggested push rule settings)
  • Explain tooling for LCM and quality safety (Renovatebot)
  • Explain development stuff for each template (npm scripts and reference to external tools (e.g. Vite, Vitest, Vue DevTools, PatternLab, Linters, and more, ...), AppSwitcher UI for local setup, vue devtools usage and LAUNCH_EDITOR env variable, maven commands, flyway usage, ...)

Additional context (optional)

No response

No duplicate

  • I confirm that this issue is not a duplicate

Code of Conduct

  • I agree to follow this project's Code of Conduct
@devtobi devtobi added Priority: High The issue contains work with high priority. Type: Documentation The issue contains work for the documentation labels Jan 9, 2025
@devtobi devtobi added this to the Release 1.0 milestone Jan 10, 2025
@devtobi devtobi moved this from Open to Accepted in it@M RefArch Templates Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: High The issue contains work with high priority. Type: Documentation The issue contains work for the documentation
Projects
Status: Accepted
Development

No branches or pull requests

1 participant