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

Fix docs link for OkHttp #3213

Merged
merged 2 commits into from
Oct 17, 2023
Merged

Conversation

SubhrajyotiSen
Copy link
Contributor

The documentation for OkHttp has been moved to https://square.github.io/okhttp/5.x/okhttp/okhttp3/

As per square/okhttp@05718b4, they are currently using HTML for docs and not markdown

The documentation for OkHttp has been moved to https://square.github.io/okhttp/5.x/okhttp/okhttp3/

As per square/okhttp@05718b4, they are currently using HTML for docs and not markdown
@IgnatBeresnev IgnatBeresnev self-requested a review October 17, 2023 08:36
Copy link
Member

@IgnatBeresnev IgnatBeresnev left a comment

Choose a reason for hiding this comment

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

Thanks for noticing and fixing the link!

Could you please also fix it for the list in docs/topics/dokka-introduction.md? That's the documentation that gets deployed to kotlinlang.org

@SubhrajyotiSen
Copy link
Contributor Author

@IgnatBeresnev Thanks for pointing me to the exact file. I've updated it

@IgnatBeresnev
Copy link
Member

Awesome, thank you once again!

@IgnatBeresnev IgnatBeresnev merged commit 73b81ac into Kotlin:master Oct 17, 2023
github-merge-queue bot referenced this pull request in slackhq/foundry Mar 5, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [org.jetbrains.dokka](https://github.com/Kotlin/dokka) | plugin |
patch | `1.9.10` -> `1.9.20` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>Kotlin/dokka (org.jetbrains.dokka)</summary>

### [`v1.9.20`](https://github.com/Kotlin/dokka/releases/tag/v1.9.20):
1.9.20

#### General bugfixes

- Fixed sealed interfaces not having the `sealed` keyword in signatures
([https://github.com/Kotlin/dokka/issues/2994](https://github.com/Kotlin/dokka/issues/2994))
- Fixed incorrect links in multi-module projects with non-unique package
names
([https://github.com/Kotlin/dokka/issues/2272](https://github.com/Kotlin/dokka/issues/2272)).
Huge thanks to [@&#8203;EddieRingle](https://github.com/EddieRingle)!
- Fixed member extensions not being shown on index pages in certain
scenarios
([https://github.com/Kotlin/dokka/issues/3187](https://github.com/Kotlin/dokka/issues/3187))
- Fixed Java's inner classes not having the `inner` keyword in Kotlin
signatures
([https://github.com/Kotlin/dokka/issues/2793](https://github.com/Kotlin/dokka/issues/2793))
- Fixed Java's `@param` tag not working with type parameters
([https://github.com/Kotlin/dokka/issues/3199](https://github.com/Kotlin/dokka/issues/3199))
- Fixed Dokka failing in KMP projects when the JVM source set is
suppressed
([https://github.com/Kotlin/dokka/issues/3209](https://github.com/Kotlin/dokka/issues/3209))

#### HTML format

- Provide an ability to add a custom homepage link to the header, more
details in
[https://github.com/Kotlin/dokka/issues/2948#issuecomment-1976723089](https://github.com/Kotlin/dokka/issues/2948#issuecomment-1976723089)
- Fixed tab selection resetting after navigating to a different page
([https://github.com/Kotlin/dokka/issues/2899](https://github.com/Kotlin/dokka/issues/2899))
- Fixed inline code not always being aligned with the surrounding text
([https://github.com/Kotlin/dokka/issues/3228](https://github.com/Kotlin/dokka/issues/3228))
- Fixed the "No options found" text in search being barely visible
([https://github.com/Kotlin/dokka/issues/3281](https://github.com/Kotlin/dokka/issues/3281))
- Fixed empty HTML tags being rendered for no reason
([https://github.com/Kotlin/dokka/pull/3343](https://github.com/Kotlin/dokka/pull/3343),
[https://github.com/Kotlin/dokka/issues/3095](https://github.com/Kotlin/dokka/issues/3095))

#### Runners

##### Gradle Plugin

- Mark tasks as not compatible with Gradle configuration cache, second
try
([https://github.com/Kotlin/dokka/pull/3438](https://github.com/Kotlin/dokka/pull/3438)).
Thanks to [@&#8203;3flex](https://github.com/3flex) for noticing and
fixing the problem!

##### Maven Plugin

- Fixed `dokka:help` being absent
([https://github.com/Kotlin/dokka/issues/3035](https://github.com/Kotlin/dokka/issues/3035)).
Thanks to [@&#8203;aSemy](https://github.com/aSemy)!
- Fixed the source links configuration not working
([https://github.com/Kotlin/dokka/pull/3046](https://github.com/Kotlin/dokka/pull/3046)).
Thanks to [@&#8203;freya022](https://github.com/freya022) for fixing
this one!

##### CLI runner

- Allow using relative paths in the `sourceRoots` configuration option
([https://github.com/Kotlin/dokka/issues/2571](https://github.com/Kotlin/dokka/issues/2571))

#### Plugin API

- Provide an extension point to customize the rendering of code blocks
in HTML format
([https://github.com/Kotlin/dokka/issues/3244](https://github.com/Kotlin/dokka/issues/3244))

#### Other:

- Make sure `wasm-js` and `wasm-wasi` targets introduced in Kotlin
1.9.20 are supported
([https://github.com/Kotlin/dokka/issues/3310](https://github.com/Kotlin/dokka/issues/3310))
- Avoid concurrent invocations of Kotlin compiler's API due to the
compiler API itself not always being thread safe
([https://github.com/Kotlin/dokka/issues/3151](https://github.com/Kotlin/dokka/issues/3151)).
No noticeable performance loss is expected.
- Bump dependencies to the latest versions
([https://github.com/Kotlin/dokka/pull/3231](https://github.com/Kotlin/dokka/pull/3231),
[https://github.com/Kotlin/dokka/pull/3206](https://github.com/Kotlin/dokka/pull/3206),
[https://github.com/Kotlin/dokka/pull/3204](https://github.com/Kotlin/dokka/pull/3204))
- Fix a documentation link
([https://github.com/Kotlin/dokka/pull/3213](https://github.com/Kotlin/dokka/pull/3213)).
Thanks to [@&#8203;SubhrajyotiSen](https://github.com/SubhrajyotiSen)
for noticing and fixing it!
- Various build and project structure improvements
([https://github.com/Kotlin/dokka/pull/3174](https://github.com/Kotlin/dokka/pull/3174),
[https://github.com/Kotlin/dokka/issues/3132](https://github.com/Kotlin/dokka/issues/3132)).
Enormous thanks to [@&#8203;aSemy](https://github.com/aSemy) for the
help!

See [Dokka
1.9.20](https://github.com/Kotlin/dokka/milestone/30?closed=1)
milestone for the list of all changes.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjcuMSIsInVwZGF0ZWRJblZlciI6IjM3LjIyNy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
github-merge-queue bot referenced this pull request in slackhq/circuit Mar 5, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [org.jetbrains.dokka](https://github.com/Kotlin/dokka) | plugin |
patch | `1.9.10` -> `1.9.20` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>Kotlin/dokka (org.jetbrains.dokka)</summary>

### [`v1.9.20`](https://github.com/Kotlin/dokka/releases/tag/v1.9.20):
1.9.20

#### General bugfixes

- Fixed sealed interfaces not having the `sealed` keyword in signatures
([https://github.com/Kotlin/dokka/issues/2994](https://github.com/Kotlin/dokka/issues/2994))
- Fixed incorrect links in multi-module projects with non-unique package
names
([https://github.com/Kotlin/dokka/issues/2272](https://github.com/Kotlin/dokka/issues/2272)).
Huge thanks to [@&#8203;EddieRingle](https://github.com/EddieRingle)!
- Fixed member extensions not being shown on index pages in certain
scenarios
([https://github.com/Kotlin/dokka/issues/3187](https://github.com/Kotlin/dokka/issues/3187))
- Fixed Java's inner classes not having the `inner` keyword in Kotlin
signatures
([https://github.com/Kotlin/dokka/issues/2793](https://github.com/Kotlin/dokka/issues/2793))
- Fixed Java's `@param` tag not working with type parameters
([https://github.com/Kotlin/dokka/issues/3199](https://github.com/Kotlin/dokka/issues/3199))
- Fixed Dokka failing in KMP projects when the JVM source set is
suppressed
([https://github.com/Kotlin/dokka/issues/3209](https://github.com/Kotlin/dokka/issues/3209))

#### HTML format

- Provide an ability to add a custom homepage link to the header, more
details in
[https://github.com/Kotlin/dokka/issues/2948#issuecomment-1976723089](https://github.com/Kotlin/dokka/issues/2948#issuecomment-1976723089)
- Fixed tab selection resetting after navigating to a different page
([https://github.com/Kotlin/dokka/issues/2899](https://github.com/Kotlin/dokka/issues/2899))
- Fixed inline code not always being aligned with the surrounding text
([https://github.com/Kotlin/dokka/issues/3228](https://github.com/Kotlin/dokka/issues/3228))
- Fixed the "No options found" text in search being barely visible
([https://github.com/Kotlin/dokka/issues/3281](https://github.com/Kotlin/dokka/issues/3281))
- Fixed empty HTML tags being rendered for no reason
([https://github.com/Kotlin/dokka/pull/3343](https://github.com/Kotlin/dokka/pull/3343),
[https://github.com/Kotlin/dokka/issues/3095](https://github.com/Kotlin/dokka/issues/3095))

#### Runners

##### Gradle Plugin

- Mark tasks as not compatible with Gradle configuration cache, second
try
([https://github.com/Kotlin/dokka/pull/3438](https://github.com/Kotlin/dokka/pull/3438)).
Thanks to [@&#8203;3flex](https://github.com/3flex) for noticing and
fixing the problem!

##### Maven Plugin

- Fixed `dokka:help` being absent
([https://github.com/Kotlin/dokka/issues/3035](https://github.com/Kotlin/dokka/issues/3035)).
Thanks to [@&#8203;aSemy](https://github.com/aSemy)!
- Fixed the source links configuration not working
([https://github.com/Kotlin/dokka/pull/3046](https://github.com/Kotlin/dokka/pull/3046)).
Thanks to [@&#8203;freya022](https://github.com/freya022) for fixing
this one!

##### CLI runner

- Allow using relative paths in the `sourceRoots` configuration option
([https://github.com/Kotlin/dokka/issues/2571](https://github.com/Kotlin/dokka/issues/2571))

#### Plugin API

- Provide an extension point to customize the rendering of code blocks
in HTML format
([https://github.com/Kotlin/dokka/issues/3244](https://github.com/Kotlin/dokka/issues/3244))

#### Other:

- Make sure `wasm-js` and `wasm-wasi` targets introduced in Kotlin
1.9.20 are supported
([https://github.com/Kotlin/dokka/issues/3310](https://github.com/Kotlin/dokka/issues/3310))
- Avoid concurrent invocations of Kotlin compiler's API due to the
compiler API itself not always being thread safe
([https://github.com/Kotlin/dokka/issues/3151](https://github.com/Kotlin/dokka/issues/3151)).
No noticeable performance loss is expected.
- Bump dependencies to the latest versions
([https://github.com/Kotlin/dokka/pull/3231](https://github.com/Kotlin/dokka/pull/3231),
[https://github.com/Kotlin/dokka/pull/3206](https://github.com/Kotlin/dokka/pull/3206),
[https://github.com/Kotlin/dokka/pull/3204](https://github.com/Kotlin/dokka/pull/3204))
- Fix a documentation link
([https://github.com/Kotlin/dokka/pull/3213](https://github.com/Kotlin/dokka/pull/3213)).
Thanks to [@&#8203;SubhrajyotiSen](https://github.com/SubhrajyotiSen)
for noticing and fixing it!
- Various build and project structure improvements
([https://github.com/Kotlin/dokka/pull/3174](https://github.com/Kotlin/dokka/pull/3174),
[https://github.com/Kotlin/dokka/issues/3132](https://github.com/Kotlin/dokka/issues/3132)).
Enormous thanks to [@&#8203;aSemy](https://github.com/aSemy) for the
help!

See [Dokka
1.9.20](https://github.com/Kotlin/dokka/milestone/30?closed=1)
milestone for the list of all changes.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjcuMSIsInVwZGF0ZWRJblZlciI6IjM3LjIyNy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
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.

2 participants