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

What about grouping the sample per service category ? #138

Closed
agoncal opened this issue Dec 31, 2021 · 3 comments · Fixed by #144
Closed

What about grouping the sample per service category ? #138

agoncal opened this issue Dec 31, 2021 · 3 comments · Fixed by #144
Assignees

Comments

@agoncal
Copy link
Collaborator

agoncal commented Dec 31, 2021

Please provide us with the following information:

This issue is for a: (mark with an x)

- [ ] bug report -> please search issues before submitting
- [x] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Mention any other details that might be useful

The samples are all ordered by service (e.g. AKS, CosmosDB...) and not by service category (e.g. Compute, Databases...) which then end up following an alphabetical order:

aci/
acr/
adx/
aks/
appservice/
aro/
cosmosdb/
eventhubs/
functions/
group/
keyvault/
mssql/
mysql/
postgresql/
redis/
servicebus/
spring-cloud/
storage/

If you look at something like Azure Charts, the services are ordered per category:

AI + Machine Learning
Analytics
Compute
Databases
Development
Identity + Security
IoT + MR
Integration
Management + Governance
Media + Comms
Migration
Networking
Storage

What about reordering the samples and grouping them by category ? We could end up, either with an extra directory:

analytics/
  adx/
  eventhubs/
compute/
  aci/
  acr/
  aks/
  appservice/
  aro/
  functions/
core/
  group/
databases/
  cosmosdb/
  mssql/
  mysql/
  postgresql/
  redis/
development/
  spring-cloud/
integration/
  servicebus/
security/
  keyvault/
storage/
  storage/

Or with a prefix of the category:

analytics-adx/
analytics-eventhubs/
compute-aci/
compute-acr/
compute-aks/
compute-appservice/
compute-aro/
compute-functions/
core-group/
databases-cosmosdb/
databases-mssql/
databases-mysql/
databases-postgresql/
databases-redis/
development-spring-cloud/
integration-servicebus/
security-keyvault/
storage-storage/

We can even flatten the entire structure:

analytics-adx-create-database/
analytics-adx-create-table/
analytics-adx-create/
analytics-adx-ingest-client/
analytics-eventhubs-create-eventhub/
analytics-eventhubs-create-namespace/
analytics-eventhubs-receive-event/
analytics-eventhubs-send-event
...
@mnriem
Copy link
Contributor

mnriem commented Jan 4, 2022

I would have no problem with reordering. Just not by what Azure Charts does, but rather by what the Azure Portal does as that is the official source. Note that if you do the reordering you will have to take into account that all the READMEs need to be touched ;)

@agoncal
Copy link
Collaborator Author

agoncal commented Jan 4, 2022

Yes, it makes sense to take the official Azure Portal organization.

So @mnriem, what do you like the best ?

  1. Extra Sub directories
analytics/
  adx/
    create-database/
    eventhubs/
  eventhubs/
  1. Sub directories
analytics-adx/
    create-database/
    eventhubs/
analytics-eventhubs/
  1. Flat structure
analytics-adx-create-database/
analytics-adx-eventhubs/
analytics-eventhubs-create/

I quite like the flat structure (it's also easier to point at external files/readmes in terms of relative paths) but it can quickly end up having hundreds of directories (one per example)

@mnriem
Copy link
Contributor

mnriem commented Jan 4, 2022

@agoncal For me it would be 1.

@agoncal agoncal self-assigned this Jan 4, 2022
agoncal added a commit that referenced this issue Jan 5, 2022
Group samples by category (and services)
Fixes #138
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 a pull request may close this issue.

2 participants