1
0
mirror of https://github.com/minio/docs.git synced 2025-04-21 08:05:59 +03:00

28 Commits

Author SHA1 Message Date
Rushan
594a9cfb6e
Replace Algolia DocSearch with InstantSearch (#621)
- Rendered only the relevant search results that has the match-level of
either `full` or `partial`.
- Added refinements to display results from other platforms (Active
platform is selected by default).
- Better title and hierarchical display.

![title](https://user-images.githubusercontent.com/13393018/198229684-3018b591-a54c-4b4f-80db-94c11e33ec65.svg)


- Added icons to represent the hierarchy level.

![icons](https://user-images.githubusercontent.com/13393018/198228150-143153bf-aa9a-4c41-baf8-bd9fa3d33bf2.png)
- Relevant results on full/partial match queries.
<img width="595" alt="Screenshot 2022-10-27 at 12 09 26"
src="https://user-images.githubusercontent.com/13393018/198228440-3a7b52a6-9f33-4778-a2ab-15b1454ede99.png">

- TODO: Keyboard shortcut to trigger/focus the search modal. (Will
address this with a new PR)
2022-11-02 09:21:21 -05:00
Ravind Kumar
581de9f9ea
Attempting to enable github rendering of markdown (#623)
# Summary

The default Markdown parser MyST provides doesn't seem to like the way
we've designed our SDK Markdown docs.

This change *should* enable github-strict parsing. It also adds
auto-headers to all H1s, which might resolve some of the TOC issues.

This gives us some breathing room to fixup the SDKs where we can still
allow for the files to look good in GitHub, but know they will render
properly on our Sphinx-built docs.
2022-11-01 12:02:29 -04:00
Ravind Kumar
4e4cc97f45 Major overhaul for Monitoring docs: Part 1 2022-10-28 16:27:01 -04:00
Daryl White
1963d67a64
Changes to get Algolia crawler to pull OpenShift docs (#613)
Algolia's crawler is not picking up the OpenShift docs.
This has fixes to get the sitemap to build correctly so the OpenShift
docs can be crawled.
2022-10-17 14:38:29 -05:00
Ravind Kumar
32366b2a15
Adding OpenShift Platform (#577)
# Summary

This pull adds back the OpenShift docs as a full dedicated platform

The main changes are:

- Adding the conditionals for OpenShift
- Modifying the Makefile for the new platform
- Adding the tutorials back in
- Fixing up the navigation headers

This was not too much trouble, which bodes well for the future.
2022-09-29 10:37:08 -04:00
Daryl White
92ee087d4f
Updating all references to docs.min.io URLs (#584)
Updating remaining links to the old docs site to point to the new URLs.

Closes #581
2022-09-26 14:21:29 -05:00
Ravind Kumar
1cc507564c
Initial work for git-managed redirects (#556)
This is the initial work for what should be a git-managed set of nginx
configs we can include into the Nginx Docs server.

The idea here is we manage redirects in git, and either chron-copy them
to a location we can include via the sites-available/<file>, *or* we
just include them from the git path (if nginx tolerates that)

I can't really _test_ these right now since they are using live URLs. if
we move forward with the soft-launch, we'll have a few opportunities to
maybe test a subset of these URLs and see what happens.

Please let me know if there is anything *obviously* wrong here.

ToDo: The Legacy Docs redirects
2022-09-20 12:27:40 -04:00
Rushan
735b6be2ce
UI enhancements: Search modal, scrollbars and permalink text (#564)
- Fix search source title background overlap.
- Remove default permalink text. (This'll remove the pilcrow sign
displayed after each search result).
- Enhance search modal's scrollbar colors.
2022-09-19 15:00:53 -05:00
Ravind Kumar
d815aa9ce8
Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Rushan
5efcffbff1
Implement Algolia search (#553) 2022-09-16 13:46:52 -05:00
Daryl White
8842084dd0
Updating base URLs for crawler and intersphinx links (#561)
Algolia crawler requires the baseURLs be bare domains, otherwise a conflict arises between the loaded page and the defined canonical URL in each page. This causes the Algolia crawler to reject the page and not find anything to index in the docs.

Also corrects Intersphinx errors at build time resulting from not having the correct paths to linux and kubernetes docs.
2022-09-16 10:51:05 -05:00
Daryl White
6423ebbd73
Add extension to create sitemaps (#547)
Adding sitemap generator extension and a sitemap_index.xml file we can share with the web site team.
2022-09-09 10:05:42 -05:00
Ravind Kumar
40cd778e5b
Completion of SSE-KMS doc rewrite (#539) 2022-09-06 17:38:08 -04:00
Rushan
dc454d7246
UI enhancements: Nav active state, Copy button UI and Text colors (#524)
* Update footer text color

* Add hover color for nav links

* Update the copy button UI

* Add active class on content nav based on platform
2022-08-15 13:11:36 -04:00
Ravind Kumar
2376fa9924
DOCS-IA: Platformize SSE Docs. Hashicorp Pass (#518)
* Platformization of Data Encryption Docs: Hashicorp Pass

* Platformization of Data Encryption Docs: Hashicorp Pass

* Big pass, CR changes + K8s
2022-08-15 12:53:08 -04:00
Rushan
c6e1fc6124
Update theme as per the new design specs (#522) 2022-08-12 10:35:15 -05:00
Ravind Kumar
c783e10594 DOCS-492: Container Platform Docs
This commit also generally cleans up the Installation docs and uses /includes/<platform>/steps-*.rst as a pattern for storing platform-specific tutorials within a single root URL.

Finally, due to API rate limits, this commit adds some Makefile magic to allow skipping of sync'ing dependencies. Pass `make BUILD_DEPENDENCIES=FALSE <platform>` to skip building any deps and use what is already in the branch.
2022-07-18 17:46:59 -04:00
Ravind Kumar
1c416561ef Cleaning up Network Encryption pages 2022-07-05 16:43:55 -04:00
Daryl White
8d15d1714a Adding content and instructions for SDKs 2022-06-29 16:07:50 -05:00
Ravind Kumar
ffeff0365e Migrate Tenant Deployment/management guides 2022-06-16 15:41:56 -04:00
Daryl White
1ef454bf05 Adding kubectl ref docs 2022-06-15 13:34:04 -05:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00
Ravind Kumar
cc150a3a73 Fixing default-conf 2022-06-02 19:42:37 -04:00
Daryl White
6e4422b029 Add mc support commands and a new support section with SUBNET info 2022-05-20 16:59:31 -05:00
Daryl White
3b5b5e4b46 Correcting subnet replacement to fix link rendering issue 2022-05-16 14:10:20 -05:00
Ravind Kumar
244d873a73 Sync for MinIO Server Release RELEASE.2022-03-03 2022-03-04 12:39:19 -05:00
ravindk89
ef4541a085 DOCS-412: Node and Drive Recovery Procedures
Klaus suggestions

Adding Eco's suggestions

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>

CR updates

Additional review comments

final work
2022-01-24 17:20:53 -05:00
ravindk89
a6fb44ac60 Updating makefile to pull latest MinIO version and DEB/RPM URLS 2022-01-10 20:35:20 -05:00