[DX-1496] Refactor Blob Lang Methods Page For Indexing #5036

dcs3spp · 2024-07-09T09:23:29Z

User description

For internal users - Please add a Jira DX PR ticket to the subject!

DX-1496

Preview Link

Refactored methods page and introduced the following subpages:

Description

Reduce length of Bloblang methods page to enable indexing by refactoring into method topics, current page too long!

Screenshots (if appropriate)

Checklist

I have added a preview link to the PR description.
I have reviewed the guidelines for contributing to this repository.
I have read the technical guidelines for contributing to this repository.
Make sure you have started your change off our latest master.
I labelled the PR

PR Type

Documentation

Description

Added comprehensive documentation for various Bloblang methods including JSON Web Tokens, object and array manipulation, string manipulation, timestamp manipulation, number manipulation, and parsing methods.
Each method includes detailed parameters and practical examples.
Fixed links in the Bloblang functions documentation.

Changes walkthrough 📝

Relevant files

Documentation

7 files

json-web-tokens.md `Add JSON Web Tokens Methods Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/json-web-tokens.md Added documentation for parsing and signing JSON Web Tokens (JWT) using various algorithms. Included examples for each JWT method. Detailed parameters for each method.	+381/-0
object-and-arrays.md `Add Object and Array Methods Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/object-and-arrays.md Added documentation for object and array manipulation methods. Included examples for each method. Detailed parameters for each method.	+811/-0
strings.md `Add String Manipulation Methods Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/strings.md Added documentation for string manipulation methods. Included examples for each method. Detailed parameters for each method.	+547/-0
timestamps.md `Add Timestamp Manipulation Methods Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/timestamps.md Added documentation for timestamp manipulation methods. Included examples for each method. Detailed parameters for each method.	+329/-0
numbers.md `Add Number Manipulation Methods Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/numbers.md Added documentation for number manipulation methods. Included examples for each method. Detailed parameters for each method.	+423/-0
parsing.md `Add Parsing Methods Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/parsing.md Added documentation for parsing methods. Included examples for each method. Detailed parameters for each method.	+382/-0
functions.md `Fix Links in Bloblang Functions Documentation` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/functions.md Fixed links to the `encode` and `string` methods in the content function documentation.	+1/-1

Additional files (token-limit)

8 files

encoding-and-encryption.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/encoding-and-encryption.md ...	+195/-0
overview.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/overview.md ...	+167/-0
type-coercion.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/type-coercion.md ...	+170/-0
regular-expressions.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/regular-expressions.md ...	+133/-0
overview.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/overview.md ...	+5/-5
geoip.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/methods/geoip.md ...	+71/-0
arithmetic.md `...` tyk-docs/content/product-stack/tyk-streaming/guides/bloblang/arithmetic.md ...	+2/-2
menu.yaml `...` tyk-docs/data/menu.yaml ...	+46/-2

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

netlify · 2024-07-09T09:25:25Z

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	`fc76c5d`
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/6690012ee31a220008581325
😎 Deploy Preview	https://deploy-preview-5036--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dcs3spp · 2024-07-09T10:03:49Z

Closing until pages linked and ready for review, will then reopen for review

Added missing links

moved up under numbers

dcs3spp · 2024-07-11T16:35:25Z

/release to release-5.4

tykbot · 2024-07-11T16:35:45Z

Working on it! Note that it can take a few minutes.

refactor methods page for indexing --------- Co-authored-by: Simon Pears <simon@tyk.io> Co-authored-by: Yaara <yaara@tyk.io> Co-authored-by: Yaara <letz.yaara@gmail.com> (cherry picked from commit cf089bf)

tykbot · 2024-07-11T16:36:08Z

@dcs3spp Succesfully merged PR

… Indexing (#5036) [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) refactor methods page for indexing --------- Co-authored-by: Simon Pears <simon@tyk.io> Co-authored-by: Yaara <yaara@tyk.io> Co-authored-by: Yaara <letz.yaara@gmail.com>

dcs3spp · 2024-08-01T11:42:59Z

/release to release-5.3

tykbot · 2024-08-01T11:43:12Z

Working on it! Note that it can take a few minutes.

refactor methods page for indexing --------- Co-authored-by: Simon Pears <simon@tyk.io> Co-authored-by: Yaara <yaara@tyk.io> Co-authored-by: Yaara <letz.yaara@gmail.com> (cherry picked from commit cf089bf)

tykbot · 2024-08-01T11:43:33Z

@dcs3spp Succesfully merged PR

dcs3spp · 2024-08-01T11:58:06Z

/release to release-5.3

tykbot · 2024-08-01T11:58:21Z

Working on it! Note that it can take a few minutes.

refactor methods page for indexing --------- Co-authored-by: Simon Pears <simon@tyk.io> Co-authored-by: Yaara <yaara@tyk.io> Co-authored-by: Yaara <letz.yaara@gmail.com> (cherry picked from commit cf089bf)

tykbot · 2024-08-01T11:58:44Z

@dcs3spp Succesfully merged PR

dcs3spp · 2024-08-01T12:04:40Z

/release to 5.3

tykbot · 2024-08-01T12:04:52Z

@dcs3spp Release branch not found

dcs3spp · 2024-08-01T12:05:03Z

/release to release-5.3

tykbot · 2024-08-01T12:05:17Z

Working on it! Note that it can take a few minutes.

refactor methods page for indexing --------- Co-authored-by: Simon Pears <simon@tyk.io> Co-authored-by: Yaara <yaara@tyk.io> Co-authored-by: Yaara <letz.yaara@gmail.com> (cherry picked from commit cf089bf)

tykbot · 2024-08-01T12:05:42Z

@dcs3spp Succesfully merged PR

… Indexing (#5036) (#5145) * [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) Co-authored-by: Simon Pears <simon@tyk.io>

dcs3spp added the now label Jul 9, 2024

dcs3spp changed the title ~~[DX-1496] Initial commit to extract parsing methods~~ [DX-1496] Refactor Blob Lang Methods Page For Indexing Jul 9, 2024

dcs3spp closed this Jul 9, 2024

dcs3spp reopened this Jul 9, 2024

Simon Pears added 24 commits July 9, 2024 14:57

initial commit to extract parsing methods

90d758d

draft commit update headers

79e8b4a

add parsing to menu

faee612

update parsing headings styles

5241c05

fix links

e45eb15

add intro

4078a76

add encoding and encryption

35aa446

add JSON web tokens

9acd4ec

add geoip methods

59fb318

add number manipulation methods

5602791

add regular expression methods

e9bc0b7

add timestamp methods

1f9a7e0

format string manipulation methods

a285d61

add string manipulation page

393b709

rename numbers file

948154b

add type coercion methods

8723d01

add draft commit for object and arrays content

667b9b6

add formatted headers for objects and arrays

a04149d

add objects & arrays intro

b504e5f

add linking paragraph to general methods

aa8c7be

draft commit for adding links to types of methods

85bf572

add links to types of methods

ad29056

fix menu.yaml error

bc8db8c

add methods overview page

2f0a7a5

letzya added 2 commits July 11, 2024 16:43

Update overview.md

5cb59ff

Added missing links

Update menu.yaml

072ba6c

moved up under numbers

letzya approved these changes Jul 11, 2024

View reviewed changes

fixed links I broke

fc76c5d

dcs3spp merged commit cf089bf into master Jul 11, 2024
10 checks passed

dcs3spp deleted the dx-1496 branch July 11, 2024 16:35

buger mentioned this pull request Jul 11, 2024

Merging to release-5.4: [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) #5063

Merged

buger mentioned this pull request Aug 1, 2024

Merging to release-5.3: [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) #5142

Closed

buger mentioned this pull request Aug 1, 2024

Merging to release-5.3: [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) #5144

Closed

buger mentioned this pull request Aug 1, 2024

Merging to release-5.3: [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) #5145

Merged

dcs3spp pushed a commit that referenced this pull request Aug 1, 2024

Merging to release-5.3: [DX-1496] Refactor Blob Lang Methods Page For…

6f424e5

… Indexing (#5036) (#5145) * [DX-1496] Refactor Blob Lang Methods Page For Indexing (#5036) Co-authored-by: Simon Pears <simon@tyk.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX-1496] Refactor Blob Lang Methods Page For Indexing #5036

[DX-1496] Refactor Blob Lang Methods Page For Indexing #5036

dcs3spp commented Jul 9, 2024 •

edited

Loading

netlify bot commented Jul 9, 2024 •

edited

Loading

dcs3spp commented Jul 9, 2024

dcs3spp commented Jul 11, 2024

tykbot bot commented Jul 11, 2024

tykbot bot commented Jul 11, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

[DX-1496] Refactor Blob Lang Methods Page For Indexing #5036

[DX-1496] Refactor Blob Lang Methods Page For Indexing #5036

Conversation

dcs3spp commented Jul 9, 2024 • edited Loading

User description

For internal users - Please add a Jira DX PR ticket to the subject!

Preview Link

Description

Screenshots (if appropriate)

Checklist

PR Type

Description

Changes walkthrough 📝

netlify bot commented Jul 9, 2024 • edited Loading

✅ PS. Pls add /docs/nightly to the end of url

dcs3spp commented Jul 9, 2024

dcs3spp commented Jul 11, 2024

tykbot bot commented Jul 11, 2024

tykbot bot commented Jul 11, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

tykbot bot commented Aug 1, 2024

dcs3spp commented Jul 9, 2024 •

edited

Loading

netlify bot commented Jul 9, 2024 •

edited

Loading