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

Maestro Dev Documentation #277

Open
wants to merge 34 commits into
base: master
Choose a base branch
from
Open

Maestro Dev Documentation #277

wants to merge 34 commits into from

Conversation

MitchellShiell
Copy link

@MitchellShiell MitchellShiell commented Oct 9, 2024

The branch is linked and rendered on a single, easy-to-navigate developer hub that beautifully renders all our product documentation from the /docs folder of all our GitHub repositories.

  • An updated Readme.md file.
  • A /docs folder with the following basic structure:
.
├── /overview
└── /setup

Usage will be added next (but not included in this round of review)

  • An updated contributing file
  • An updated code_of_conduct file
  • An updated license.md file
  • An updated Application.yaml file

User Guides

  • Indexing Data
  • Exclusion Rules
  • Index mappings
  • Kafka Topics
  • Slack Notifications
  • API Reference

Important

Before going live will need to update any links to the demo discussion board and Netlify deploy preview

To Review

@MitchellShiell MitchellShiell changed the title [WIP] - Maestro Dev Documentation Maestro Dev Documentation Nov 22, 2024
@MitchellShiell MitchellShiell marked this pull request as ready for review November 22, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants