Skip to content

Commit 908d84f

Browse files
committed
Follow up #2286 Release v24.0 | Artifacts and bug fixing
1 parent 56ae08e commit 908d84f

File tree

6 files changed

+71
-29
lines changed

6 files changed

+71
-29
lines changed

docs/_static/overrides.css

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,15 @@ blockquote {
44
aside.footnote-list {
55
font-size: 0.9em;
66
}
7+
.img-valign-middle
8+
{
9+
vertical-align: middle;
10+
}
11+
.img-valign-bottom
12+
{
13+
vertical-align: bottom;
14+
}
15+
.img-valign-textbottom
16+
{
17+
vertical-align: text-bottom;
18+
}

docs/building/building.rst

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.. role:: htm(raw)
2+
:format: html
3+
.. role:: pdf(raw)
4+
:format: latex pdflatex
15
.. _Ocelot: https://github.com/ThreeMammals/Ocelot
26
.. _Cake: https://cakebuild.net
37
.. _Bash: https://www.gnu.org/software/bash
@@ -114,22 +118,26 @@ You may need to adjust the platform flag depending on your system.
114118
With CI/CD
115119
----------
116120
.. _workflows: https://github.com/ThreeMammals/Ocelot/tree/main/.github/workflows
117-
.. _PR: https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/pr.yml
118-
.. _Develop: https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/develop.yml
119-
.. _Release: https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/release.yml
121+
.. _PR: https://github.com/ThreeMammals/Ocelot/actions/workflows/pr.yml
122+
.. _Develop: https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml
123+
.. _Release: https://github.com/ThreeMammals/Ocelot/actions/workflows/release.yml
120124
.. _Coveralls: https://coveralls.io
121125
.. |ReleaseButton| image:: https://github.com/ThreeMammals/Ocelot/actions/workflows/release.yml/badge.svg
122-
:target: https://github.com/ThreeMammals/Ocelot/actions/workflows/release.yml
123-
:alt: Release Status
126+
:target: https://github.com/ThreeMammals/Ocelot/actions/workflows/release.yml
127+
:alt: Release Status
128+
:class: img-valign-textbottom
124129
.. |DevelopButton| image:: https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml/badge.svg
125-
:target: https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml
126-
:alt: Development Status
130+
:target: https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml
131+
:alt: Development Status
132+
:class: img-valign-textbottom
127133
.. |DevelopCoveralls| image:: https://coveralls.io/repos/github/ThreeMammals/Ocelot/badge.svg?branch=develop
128-
:target: https://coveralls.io/github/ThreeMammals/Ocelot?branch=develop
129-
:alt: Coveralls Status
134+
:target: https://coveralls.io/github/ThreeMammals/Ocelot?branch=develop
135+
:alt: Coveralls Status
136+
:class: img-valign-textbottom
130137
.. |ReleaseCoveralls| image:: https://coveralls.io/repos/github/ThreeMammals/Ocelot/badge.svg?branch=main
131-
:target: https://coveralls.io/github/ThreeMammals/Ocelot?branch=main
132-
:alt: Coveralls Status
138+
:target: https://coveralls.io/github/ThreeMammals/Ocelot?branch=main
139+
:alt: Coveralls Status
140+
:class: img-valign-textbottom
133141
.. _break2: http://break.do
134142

135143
| Folder: ./.github/`workflows`_
@@ -142,7 +150,9 @@ Starting from version `24.0`_, all pull requests, development commits, and relea
142150
There are three `workflows`_: one for pull requests (`PR`_), one for the ``develop`` branch (`Develop`_), and one for the ``main`` branch (`Release`_).
143151

144152
**Note**: Each workflow has a dedicated status badge in the `Ocelot README`_:
145-
the `Release`_ |ReleaseButton| button and the `Develop`_ |DevelopButton| button, with the `PR`_ status being published directly in a pull request under the "Checks" tab.
153+
the |ReleaseButton|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/actions/workflows/release.yml}{Release}` button and
154+
the |DevelopButton|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml}{Develop}` button,
155+
with the `PR`_ status being published directly in a pull request under the "Checks" tab.
146156

147157
The `PR`_ workflow will track code coverage using `Coveralls`_.
148158
After opening a pull request or submitting a new commit to a pull request, `Coveralls`_ will publish a short message with the current code coverage once the top commit is built.
@@ -164,11 +174,13 @@ Documentation
164174
.. _README: https://github.com/ThreeMammals/Ocelot/blob/main/docs/readme.md
165175
.. _Ocelot README: https://github.com/ThreeMammals/Ocelot/blob/main/README.md
166176
.. |ReleaseDocs| image:: https://readthedocs.org/projects/ocelot/badge/?version=latest&style=flat-square
167-
:target: https://app.readthedocs.org/projects/ocelot/builds/?version__slug=latest
168-
:alt: ReadTheDocs Status
177+
:target: https://app.readthedocs.org/projects/ocelot/builds/?version__slug=latest
178+
:alt: ReadTheDocs Status
179+
:class: img-valign-middle
169180
.. |DevelopDocs| image:: https://readthedocs.org/projects/ocelot/badge/?version=develop&style=flat-square
170-
:target: https://app.readthedocs.org/projects/ocelot/builds/?version__slug=develop
171-
:alt: ReadTheDocs Status
181+
:target: https://app.readthedocs.org/projects/ocelot/builds/?version__slug=develop
182+
:alt: ReadTheDocs Status
183+
:class: img-valign-middle
172184
.. _break3: http://break.do
173185

174186
| Folder: ./`docs`_

docs/features/kubernetes.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1+
.. role:: htm(raw)
2+
:format: html
3+
.. role:: pdf(raw)
4+
:format: latex pdflatex
15
.. |K8sLogo| image:: https://raw.githubusercontent.com/kubernetes/kubernetes/master/logo/logo.png
26
:alt: K8s Logo
37
:height: 50
8+
:class: img-valign-bottom
49
:target: https://kubernetes.io
5-
6-
.. |kubernetes| image:: https://kubernetes.io/images/nav_logo2.svg
10+
.. |logo-kubernetes| image:: ../images/k8s-logo-kubernetes.png
711
:alt: kubernetes logo
8-
:height: 17
12+
:height: 30
13+
:class: img-valign-middle
914
:target: https://kubernetes.io
1015

1116
.. _KubeClient: https://www.nuget.org/packages/KubeClient
@@ -29,7 +34,7 @@ For a comprehensive understanding, it is essential refer to the `KubeClient`_ do
2934
Install
3035
-------
3136

32-
The first thing you need to do is install the `package`_ that provides |kubernetes| support in Ocelot:
37+
The first thing you need to do is install the `package`_ that provides |logo-kubernetes| support in Ocelot:
3338

3439
.. code-block:: powershell
3540

docs/features/qualityofservice.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
1+
.. role:: htm(raw)
2+
:format: html
3+
.. role:: pdf(raw)
4+
:format: latex pdflatex
15
.. _Program: https://github.com/ThreeMammals/Ocelot/blob/main/samples/Basic/Program.cs
26
.. _Polly: https://www.thepollyproject.org
37
.. _documentation: https://www.pollydocs.org
8+
.. |QoS_label| image:: https://img.shields.io/badge/-QoS-D3ADAF.svg
9+
:target: https://github.com/ThreeMammals/Ocelot/labels/QoS
10+
:alt: label QoS
11+
:class: img-valign-textbottom
412

513
Quality of Service
614
==================
715

8-
Label: |QoS_label|
16+
Repository Label: |QoS_label|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/labels/QoS}{QoS}`
917

1018
Ocelot currently supports a single *Quality of Service* (QoS) capability.
1119
It allows you to configure, on a per-route basis, the application of a circuit breaker when making requests to downstream services.
@@ -162,5 +170,3 @@ Finally, to define your own set of exceptions for mapping, you can apply the fol
162170
.. _2073: https://github.com/ThreeMammals/Ocelot/pull/2073
163171
.. _23.2: https://github.com/ThreeMammals/Ocelot/releases/tag/23.2.0
164172
.. _24.0: https://github.com/ThreeMammals/Ocelot/releases/tag/24.0.0
165-
.. |QoS_label| image:: https://img.shields.io/badge/-QoS-D3ADAF.svg
166-
:target: https://github.com/ThreeMammals/Ocelot/labels/QoS
26.8 KB
Loading

docs/introduction/gotchas.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
.. role:: htm(raw)
2+
:format: html
3+
.. role:: pdf(raw)
4+
:format: latex pdflatex
5+
16
Hosting Gotchas
27
===============
38

@@ -11,8 +16,8 @@ Please review deployment and web hosting common user scenarios below depending o
1116
IIS
1217
---
1318

14-
| Repository Label: |image-IIS| `IIS <https://github.com/ThreeMammals/Ocelot/labels/IIS>`_
15-
| Microsoft Learn: `Host ASP.NET Core on Windows with IIS <https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/>`_
19+
| Repository Label: |image-IIS|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/labels/IIS}{IIS}`
20+
| Microsoft Learn: `Host ASP.NET Core on Windows with IIS <https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/>`_
1621
1722
We **do not** recommend to deploy Ocelot app to IIS environments, but if you do, keep in mind the gotchas below.
1823

@@ -28,11 +33,12 @@ The community constanly reports `issues related to IIS <https://github.com/Three
2833
If you have some troubles in IIS environment to host Ocelot app, first of all, read open/closed issues, and after that, search for `IIS-related objects`_ in the repository.
2934
Probably you will find a ready solution by Ocelot community members.
3035

31-
Finally, we have special label |image-IIS| for all `IIS-related objects`_.
36+
Finally, there is the special |image-IIS|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/labels/IIS}{IIS}` label for all `IIS-related objects`_.
3237
Feel free to put this label onto `issues <https://github.com/ThreeMammals/Ocelot/labels/IIS>`_, `pull requests <https://github.com/ThreeMammals/Ocelot/pulls?q=is%3Apr+label%3AIIS+>`_, `discussions <https://github.com/ThreeMammals/Ocelot/discussions?discussions_q=label%3AIIS>`_, etc.
3338

3439
.. |image-IIS| image:: ../images/label-IIS-c5def5.svg
3540
:alt: label IIS
41+
:class: img-valign-bottom
3642
:target: https://github.com/ThreeMammals/Ocelot/labels/IIS
3743
.. _IIS-related objects: https://github.com/search?q=repo%3AThreeMammals%2FOcelot%20IIS&type=code
3844

@@ -41,8 +47,8 @@ Probably you will find a ready solution by Ocelot community members.
4147
Kestrel
4248
-------
4349

44-
| Repository Label: |image-Kestrel| `Kestrel <https://github.com/ThreeMammals/Ocelot/labels/Kestrel>`_
45-
| Microsoft Learn: `Kestrel web server in ASP.NET Core <https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel>`_
50+
| Repository Label: |image-Kestrel|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/labels/Kestrel}{Kestrel}`
51+
| Microsoft Learn: `Kestrel web server in ASP.NET Core <https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel>`_
4652
4753
We **do** recommend to deploy Ocelot app to self-hosting environments, aka Kestrel vs Docker.
4854
We try to optimize Ocelot web app for Kestrel & Docker hosting scenarios, but keep in mind the following gotchas.
@@ -77,11 +83,12 @@ As a quick fix, use this configuration recipe:
7783
7884
.. _break: http://break.do
7985

80-
Finally, we have special label |image-Kestrel| for all `Kestrel-related objects <https://github.com/search?q=repo%3AThreeMammals%2FOcelot%20Kestrel&type=code>`_.
86+
Finally, there is the special |image-Kestrel|:pdf:`\href{https://github.com/ThreeMammals/Ocelot/labels/Kestrel}{Kestrel}` label for all `Kestrel-related objects <https://github.com/search?q=repo%3AThreeMammals%2FOcelot%20Kestrel&type=code>`_.
8187
Feel free to put this label onto `issues <https://github.com/ThreeMammals/Ocelot/labels/Kestrel>`__, `pull requests <https://github.com/ThreeMammals/Ocelot/pulls?q=is%3Apr+label%3AKestrel+>`__, `discussions <https://github.com/ThreeMammals/Ocelot/discussions?discussions_q=label%3AKestrel>`__, etc.
8288

8389
.. |image-Kestrel| image:: ../images/label-Kestrel-c5def5.svg
8490
:alt: label Kestrel
91+
:class: img-valign-bottom
8592
:target: https://github.com/ThreeMammals/Ocelot/labels/Kestrel
8693

8794
""""

0 commit comments

Comments
 (0)