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

Update contributing guidelines to clarify docs mirroring on sdk repos #544

Closed
shelbyspees opened this issue Apr 17, 2021 · 2 comments · Fixed by #547
Closed

Update contributing guidelines to clarify docs mirroring on sdk repos #544

shelbyspees opened this issue Apr 17, 2021 · 2 comments · Fixed by #547
Assignees

Comments

@shelbyspees
Copy link
Contributor

shelbyspees commented Apr 17, 2021

This is regarding the change discussed in #472 that's been rolled out across most of the language repos.

I hope most of the friction will be solved by #542, but it'll be helpful to describe how the docs mirroring works in a bit more detail. As a bonus, describing the current process may make it easier to automate mirroring/syncing in the future.

@shelbyspees shelbyspees self-assigned this Apr 17, 2021
@shelbyspees
Copy link
Contributor Author

shelbyspees commented Apr 17, 2021

@austinlparker one of my thoughts for this is to add a readme each language's website_docs directory in those repos (and have them mirrored back here), at least so people know whether they're in the right place (i.e. "You know you're in the right place because the directory should be called website_docs" basically). That would involve opening PRs against all the language repos though, so I might hold off on that for now.

Even a readme under content/en/docs/ in here might be a good start.

@shelbyspees
Copy link
Contributor Author

shelbyspees commented Apr 17, 2021

Oh there's also the contribution guidelines page page that gets published 🤔

It's pretty buried at the bottom of the menu though so idk how many people see it. This is starting to be a lot of pages to update. Let me poke at this a bit.

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.

1 participant