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

Build translated docs to fix #797 #826

Open
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

winmorre
Copy link

To test this PR

run python ./scripts/docs.py build-all This will build the docs site

run python ./scripts/docs.py serve This will serve the doc site

@netlify
Copy link

netlify bot commented Oct 30, 2022

Deploy Preview for dynaconf ready!

Name Link
🔨 Latest commit ac45613
🔍 Latest deploy log https://app.netlify.com/sites/dynaconf/deploys/6384a21a41cafb000748156c
😎 Deploy Preview https://deploy-preview-826--dynaconf.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.

@winmorre
Copy link
Author

In release.sh file release.sh file line 102
I think there will be a need to update how the command is run. pointing to the right mkdocs.yaml file. Probably point to docs/en/mkdocs.yml file.

I think they will be a change to this command too https://github.com/dynaconf/dynaconf/blob/master/release.sh#L133
and this too https://github.com/dynaconf/dynaconf/blob/master/release.sh#L134

This too https://github.com/dynaconf/dynaconf/blob/master/netlify.toml#L5 will need to run the python ./scripts/docs.py build-all command

@rochacbruno Please check through these files and let me know the changes I'm proposing is correct

@rochacbruno
Copy link
Member

Hi @winmorre the preview site is not loading, and I guess it is because it is missing the customizations on https://github.com/dynaconf/dynaconf/blob/master/netlify.toml

@winmorre
Copy link
Author

winmorre commented Nov 3, 2022

Hi @winmorre the preview site is not loading, and I guess it is because it is missing the customizations on https://github.com/dynaconf/dynaconf/blob/master/netlify.toml

@rochacbruno Please how do I go about this?
looking the link sent but don't know what to do to fix this

@rochacbruno
Copy link
Member

Hi @winmorre the preview site is not loading, and I guess it is because it is missing the customizations on https://github.com/dynaconf/dynaconf/blob/master/netlify.toml

@rochacbruno Please how do I go about this? looking the link sent but don't know what to do to fix this

Replace mkdocs build --clean with the call to the script you added python ./scripts/docs.py build-all

@winmorre
Copy link
Author

winmorre commented Nov 4, 2022

@rochacbruno I have updated the PR

@winmorre winmorre closed this Nov 27, 2022
@winmorre winmorre reopened this Nov 27, 2022
@winmorre
Copy link
Author

@rochacbruno please I have fix the merge conflicts and I have updated the PR

@rochacbruno
Copy link
Member

thanks @winmorre to figure out the build error.

@@ -61,7 +61,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.10"]
python-version: ["3.8", "3.10", "3.11"]
Copy link
Member

Choose a reason for hiding this comment

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

@@ -275,13 +275,13 @@ With `merge_enabled` the ending `settings.server` will be
```python
{"port": 8888, "address": "server.com"}
```
otherwise it will be only what is specified in the latest loaded file. read more about [merging strategies](/merging)
otherwise it will be only what is specified in the latest loaded file. read more about [merging strategies](/docs/en/docs/merging.mdng.md)
Copy link
Member

Choose a reason for hiding this comment

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

why is it pointing to .mdng.md file?

@@ -8,7 +8,7 @@ In addition to that Dynaconf offers some approaches you may want to **Optionally

- Add a list of validators to `validators=[Validator()]` on your dynaconf settings instance and provide [defaults and constraints](/validation/).
- Enable `load_dotenv` and provide a `.env.example` or `.env` file with the default variables.
- Write your variables in a [settings file](/settings_files) in the format of your choice.
- Write your variables in a [settings file](/docs/en/docs/settings_files.mdes.md) in the format of your choice.
Copy link
Member

Choose a reason for hiding this comment

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

what does mdes.md stands for?

Copy link
Author

Choose a reason for hiding this comment

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

let me get it fixed

@@ -134,7 +134,7 @@ settings = Dynaconf(**options)

and then in your program you do `from project.config import settings` instead of `from dynaconf import settings`.

The `**options` are any of the [dynaconf config options](/configuration)
The `**options` are any of the [dynaconf config options](/docs/en/docs/configuration.mdon.md)
Copy link
Member

Choose a reason for hiding this comment

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

mdon.md?

Copy link
Author

Choose a reason for hiding this comment

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

hmmm
I actually didn't change things there
But let me fix those and update the PR

@rochacbruno
Copy link
Member

Looks like this needs a rebase from master?

@winmorre
Copy link
Author

Looks like this needs a rebase from master?

ok

@winmorre
Copy link
Author

@rochacbruno I have updated the PR

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.

None yet

3 participants