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

EPIC: uplift current documentation #951

Open
1 of 10 tasks
AlexSkrypnyk opened this issue Jul 30, 2023 · 0 comments
Open
1 of 10 tasks

EPIC: uplift current documentation #951

AlexSkrypnyk opened this issue Jul 30, 2023 · 0 comments
Assignees
Labels
State: Confirmed The issue was triaged and confirmed for development Type: Documentation Issue is related to documentation
Milestone

Comments

@AlexSkrypnyk
Copy link
Member

AlexSkrypnyk commented Jul 30, 2023

https://docs.drevops.com/ has some docs added. We need to fill-in all the missing sections.

  • Diagram of build
  • Diagram of site install
  • CI docs
    • Caching of the database
    • Dind for consistency
    • Parallel runners for tests
    • Deployment regexes and tests for them
    • Setting up CI steps
    • Builder container
    • Build and test artifacts
  • Composer.json - features explained
  • Drupal
    • Different approach to settings.php - single file + modules VS per-env file + modules etc.
    • More about settings:
      • Environment var definition
      • Global vs per env settings
      • Local settings
      • Include files for modules
    • Inline with drupal-project
    • Explain what each dependency does
    • Asset-manager
    • Explain to commit lock file after installing
    • Min stability
    • Explain platform
    • Theme scaffold:
      • Subtheme
      • Tests
      • Fe compilation
      • Components dir
      • Livereload
      • Sass
      • Grunt
    • Module scaffold
      • Tests
      • Prevent sending emails
      • Enabling contribs for clam, search, redis
  • Database
    • Didi vs difi workflows
    • Caching in ci
    • Sanitisation during install
  • Test
    • Add allow fail vars
    • Add linting info
  • Notifications
  • Deployments (Setting up every type of the deployment)
  • Explain example names like yoursite etc - maybe a separate section about installer

Additional resources:

https://www.drupalasheville.com/sites/default/files/2020-07/Session%20-%20Taking%20Maximum%20Advantage%20of%20Drupal%20Core%27s%20Composer%20Template.pdf

@AlexSkrypnyk AlexSkrypnyk added the Type: Documentation Issue is related to documentation label Aug 21, 2023
@AlexSkrypnyk AlexSkrypnyk added this to the 1.17 milestone Sep 6, 2023
@AlexSkrypnyk AlexSkrypnyk changed the title Docs: uplift current documentation EPIC: uplift current documentation Sep 6, 2023
@AlexSkrypnyk AlexSkrypnyk modified the milestones: 1.17, 1.18, 1.19 Sep 27, 2023
@AlexSkrypnyk AlexSkrypnyk modified the milestones: 1.19, 1.20 Nov 22, 2023
@AlexSkrypnyk AlexSkrypnyk modified the milestones: 1.20, 1.21 Feb 15, 2024
@AlexSkrypnyk AlexSkrypnyk modified the milestones: 2.1, 2.0 Apr 8, 2024
@AlexSkrypnyk AlexSkrypnyk added the State: Confirmed The issue was triaged and confirmed for development label Apr 8, 2024
@AlexSkrypnyk AlexSkrypnyk self-assigned this Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
State: Confirmed The issue was triaged and confirmed for development Type: Documentation Issue is related to documentation
Projects
Status: To do for current release
Development

No branches or pull requests

1 participant