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

[BUG] API Docs down #4812

Closed
2 tasks done
bimtauer opened this issue Feb 1, 2024 · 2 comments
Closed
2 tasks done

[BUG] API Docs down #4812

bimtauer opened this issue Feb 1, 2024 · 2 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@bimtauer
Copy link
Contributor

bimtauer commented Feb 1, 2024

Describe the bug

Is it just me or are the generated API docs not available? Have they been moved? E.g.: https://docs.flyte.org/en/latest/api/flytekit/generated/flytekit.remote.remote.FlyteRemote.html used to work for me at the start of the week. Now its 404.

Expected behavior

Access to API docs

Additional context to reproduce

No response

Screenshots

image
image

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@bimtauer bimtauer added bug Something isn't working untriaged This issues has not yet been looked at by the Maintainers labels Feb 1, 2024
Copy link

dosubot bot commented Feb 1, 2024

🤖

I'm sorry to hear that you're having trouble accessing the API documentation. Based on the information you've provided, it seems like the documentation link you're trying to access is returning a 404 error. This could be due to a number of reasons, such as changes in the repository structure, updates to the documentation generation process, or issues with the hosting of the documentation.

Unfortunately, I wasn't able to find any recent changes or updates in the Flyte repository that could have affected the availability of the API documentation. There also doesn't seem to be a specific commit or pull request that could have caused the documentation to become unavailable.

The process for generating the API documentation in the Flyte repository involves running a bash script that compiles different components of the Flyte system and then generates configuration documents for each of them. If there were any issues or changes in this process, it could potentially affect the availability of the API documentation.

As for the screenshots you've provided, I'm unable to view them as I can't process images. If you could provide more details about what the screenshots show, it might help in diagnosing the issue.

In the meantime, I would recommend checking the repository for any updates or changes that might have affected the documentation. You could also try accessing the documentation from a different browser or device to see if the issue persists.

If you have any more information or context that could help in resolving this issue, please feel free to share it. I'm here to help! Dosu

Sources


This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Feb 1, 2024
@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Feb 1, 2024
@neverett
Copy link
Contributor

neverett commented Feb 1, 2024

@bimtauer thanks for flagging -- this should be fixed now by #4815 . That page (and others that were missing) is showing up for me now, but let me know if you're still seeing missing docs.

@neverett neverett closed this as completed Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants