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

Add Draft Platform Overview #397

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add Draft Platform Overview #397

wants to merge 1 commit into from

Conversation

justindbaur
Copy link
Member

🎟️ Tracking

📔 Objective

Adds a document going through an overview of the Platform team.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 17c1aeb
Status: ✅  Deploy successful!
Preview URL: https://8e5ce22c.contributing-docs.pages.dev
Branch Preview URL: https://platform-overview.contributing-docs.pages.dev

View logs

Copy link

Logo
Checkmarx One – Scan Summary & Details1f63221e-dcb9-4639-8383-1e3868d5bdfe

No New Or Fixed Issues Found

@trmartin4
Copy link
Member

trmartin4 commented Jul 27, 2024

This is excellent! Thank you for all the time you've spent getting this put together.

I had a question and a suggestion, which might help guide future changes to the doc:

  1. What is the intended audience? Is it intended for an engineering ("expert") audience? There's a lot of great detail in the doc, and I wanted to make sure that the audience is intended to be familiar enough with the concepts that you're using.
  2. Somewhat related to that, one suggestion I had is to pull the "Other Responsibilities" up to the top of the doc, and expand it to be a general "Responsibilities" section, with a bulleted list of the high-level areas of responsibility. Then you can flesh out each of those in a separate subsection below. That would help frame the document and allow us to see areas that would require further documentation. I think you've got a great writup on the "Cross-client re-usable interface development" section (if that's what we call it), and we can also flesh out other areas around build pipelines as well with its own section. What do you think about that?

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