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.

Sign up for GitHub

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

Jump to bottom

docs: split contribution and usage #423

Merged
merged 13 commits into from
Apr 26, 2022
Merged

docs: split contribution and usage #423

merged 13 commits into from
Apr 26, 2022

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Apr 25, 2022 •
edited
Loading

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-436

Changes included:

This PR splits automation content from clients usage.

  • Some small parts have been rewrote as we've update things here and there.
  • Docs links in READMEs
  • Better sidebars

🧪 Test

Netlify preview: https://deploy-preview-423--api-clients-automation.netlify.app/

@shortcuts shortcuts requested a review from a team April 25, 2022 11:56
@shortcuts shortcuts self-assigned this Apr 25, 2022
@shortcuts shortcuts requested review from eunjae-lee and damcou and removed request for a team April 25, 2022 11:56
@netlify
Copy link

netlify bot commented Apr 25, 2022 •
edited
Loading

✅ Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 26cf12c
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/6267df8fb9530a000873f69c
😎 Deploy Preview https://deploy-preview-423--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Apr 25, 2022 •
edited
Loading

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.

@shortcuts shortcuts force-pushed the docs/split-contribution-and-usage branch from cac622b to eb3d844 Compare April 26, 2022 08:30
damcou
damcou reviewed Apr 26, 2022
View reviewed changes
Copy link
Contributor

@damcou damcou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good job, this is already clearer and more structured !
I feel like we could be even more explicit in the top menu for example by changing Automation by Automation process and Clients by Supported Languages, WDYT ?

website/docs/automation/CLI/clientsCommands.md Show resolved Hide resolved
docs/submodules.md Show resolved Hide resolved
website/docs/automation/addNewClient.md Outdated Show resolved Hide resolved
website/docs/automation/addNewLanguage.md Show resolved Hide resolved
website/docs/automation/introduction.md
@@ -0,0 +1,32 @@
---
title: Introduction
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the contents of this pages should more look like the structure of the sidebar, I was a little bit confused by the fact that the "Getting Started" contents were under "Contributing" section for example.

@shortcuts shortcuts requested review from eunjae-lee and damcou April 26, 2022 09:45
@eunjae-lee
Copy link
Contributor

What if we have "Clients" first, and then "Automation" on the header? 🤔

@shortcuts
Copy link
Member Author

What if we have "Clients" first, and then "Automation" on the header? 🤔

To match the name of the project? 😂

@eunjae-lee
Copy link
Contributor

What if we have "Clients" first, and then "Automation" on the header? 🤔

To match the name of the project? 😂

😂😂😂 Didn't see that!

Anyway, I think the primary viewer of this site would be the client users, not the contributors. What do you think?

@damcou
Copy link
Contributor

damcou commented Apr 26, 2022

What if we have "Clients" first, and then "Automation" on the header? 🤔

To match the name of the project? 😂

😂😂😂 Didn't see that!

Anyway, I think the primary viewer of this site would be the client users, not the contributors. What do you think?

You don't like "Supported languages" rather than "Clients" in the top menu ? 😢

@shortcuts
Copy link
Member Author

You don't like "Supported languages" rather than "Clients" in the top menu ? 😢

I prefer API Clients actually

@damcou
Copy link
Contributor

damcou commented Apr 26, 2022

You don't like "Supported languages" rather than "Clients" in the top menu ? 😢

I prefer API Clients actually

The whole purpose of this section is not to describe the usage of the clients by language as it's done in the Get started page ?

@shortcuts
Copy link
Member Author

shortcuts commented Apr 26, 2022 •
edited
Loading

The whole purpose of this section is not to describe the usage of the clients by language as it's done in the Get started page ?

Yep, and that's how it's called on the Algolia doc too. IMO language is too broad

Screenshot 2022-04-26 at 12 07 58

@shortcuts shortcuts enabled auto-merge (squash) April 26, 2022 10:22
@damcou
Copy link
Contributor

damcou commented Apr 26, 2022

The whole purpose of this section is not to describe the usage of the clients by language as it's done in the Get started page ?

Yep, and that's how it's called on the Algolia doc too. IMO language is too broad

Screenshot 2022-04-26 at 12 07 58

Okay you win :p

damcou
damcou approved these changes Apr 26, 2022
View reviewed changes
Copy link
Contributor

@damcou damcou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shortcuts shortcuts merged commit b73da52 into main Apr 26, 2022
@shortcuts shortcuts deleted the docs/split-contribution-and-usage branch April 26, 2022 12:16
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Apr 26, 2022
@algolia-bot @shortcuts
docs: split contribution and usage
8cf7b64 
algolia/api-clients-automation#423

Co-authored-by: Clément Vannicatte <[email protected]>
This was referenced Apr 28, 2022
Closed
Closed
Closed
Closed
This was referenced May 24, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damcou damcou damcou approved these changes

@eunjae-lee eunjae-lee Awaiting requested review from eunjae-lee

Assignees

@shortcuts shortcuts

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shortcuts @algolia-bot @eunjae-lee @damcou