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

Move documentation linting to its own repository #206

Closed
16 tasks done
GuySartorelli opened this issue Feb 28, 2024 · 4 comments
Closed
16 tasks done

Move documentation linting to its own repository #206

GuySartorelli opened this issue Feb 28, 2024 · 4 comments

Comments

@GuySartorelli
Copy link
Member

GuySartorelli commented Feb 28, 2024

We're pulling linkfield docs in from that repository, and aim to pull more in going forward:

We should pull the documentation linting stuff into its own repository that can be shared across all relevant repos.

Acceptance criteria

  • Linting configuration (i.e. declaring what linting rules are applied) is in the new repository
  • All dependencies (npm and composer) are handled in the new repository
  • Repositories with documentation don't need any configuration beyond indicating where their documentation lives
  • Documentation can be linted using a command that gets added to vendor/bin/
  • Documentation can be linted both when the repository with documentation is the root dir (i.e. CI) and when it is in vendor (i.e. locally)
  • developer docs itself has the new linting repo as a dev dependency
  • Other repositories with documentation list the new repository as a composer dev dependency
  • All repositories currently pulling documentation into the developer docs site have the new linting applied
  • Docs linting is added as a regular part of CI for all relevant repositories
  • All cards for pulling new documentation in from additional repositories are updated so that adding linting is in the ACs
  • New repo is in packagist
  • New repo has appropriate branch protection rule
  • New repo is added to zenhub board
  • New repo is added to module standardiser
  • New repo is added to rhino
  • New repo is added to elvis

Note

  • We'll exclude userhelp linting for now, but we'll create a follow card for applying linting to userhelp

PRs

CI showing developer-docs happy: https://github.com/silverstripe/developer-docs/actions/runs/8532499473?pr=489
CI showing the changes to the gha-* repos work as expected: https://github.com/GuySartorelli/silverstripe-linkfield/actions/runs/8545963893/job/23415708351

After everything is merged, reassign to Guy so they can add to packagist and run standardiser across the new repo.

@GuySartorelli
Copy link
Member Author

@emteknetnz
Copy link
Member

Assigning back to @GuySartorelli so sort out packagist and ensure things are working as expected. You'll no doubt want to rerun builds for linkfield and developer docs

@GuySartorelli
Copy link
Member Author

Turns out I don't have access to the machine user we use to add packages to packagist. Can you please do that step and then reassign to me?

@GuySartorelli
Copy link
Member Author

new doc linting CI passing in both linkfield and dev docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants