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 docs for maintainers and enforce hugo version #7

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

melissawm
Copy link
Contributor

  • Make sure the site builds with the scientific python hugo theme
  • Draft documentation for maintainers
  • Also creates .gitignore

- Make sure the site builds with the scientific python hugo theme
- Draft documentation for maintainers
- Also creates .gitignore
@melissawm
Copy link
Contributor Author

Expand on the fact that we have an extra layer of indirection throught the repos at scientific-python-translations org.

@melissawm
Copy link
Contributor Author

Also, the Create translations PR targets the scientific-python-translations repos, NOT the final website repos (this is only true for NumPy.org)


## Setting up a language switcher

This work is in progress - follow (issue #) for details.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We should create an issue to update folks on how this is going.

Copy link
Contributor

@steppi steppi left a comment

Choose a reason for hiding this comment

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

Thanks @melissawm. I made some suggestions for the part about hiding duplicates, and the description for how to resolve merge conflicts.

@melissawm
Copy link
Contributor Author

I think this is good to merge.

@melissawm melissawm requested a review from goanpeca February 5, 2025 15:08
@melissawm
Copy link
Contributor Author

Hi @goanpeca - would you take a look if you have some time? I think you would be the ideal reviewer as you are now onboarding into this process. Thank you!

Copy link

@trallard trallard left a comment

Choose a reason for hiding this comment

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

I am not sure what it is, but I found this a bit hard to follow, it almost feels like set actual steps needed by maintainers are intermingled with a lot of implementation/caveat details about Crowdin and how the integration is managed.
Though, I do not have a concrete proposal as to how to improve the docs right now, perhaps keep a TLD;R or summary of what maintainers actually need to do and then refer to the rest of the content as an extended guide?

@melissawm melissawm marked this pull request as draft February 20, 2025 15:02
@melissawm melissawm marked this pull request as ready for review February 20, 2025 15:38
@melissawm
Copy link
Contributor Author

Ok - I've tried reorganizing a bit to make the steps clearer and the information about crowdin internals less intrusive.

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.

3 participants