a460f750c6
Swap headers
...
Use what was previously a second-level heading as the page title.
2023-04-29 21:39:42 +01:00
634c17f61c
Reorganize Working with Kubernetes Objects section
...
- move Understanding Kubernetes Objects to be section overview
- within the section, consistently link to the new (moved) page from the
first mention of “object”
- add a redirect
Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-04-29 21:39:42 +01:00
6cf29427f2
Merge pull request #38227 from T-Lakshmi/doc-owner-depnd
...
Updated Owners and Dependents page with glossary tooltip and reference links
2023-04-13 09:20:39 -07:00
138b825d31
Remove redundant description of finalizers
...
Remove redundant information about finalizers on the finalizers
page within the "working with objects" section.
The same description of finalizers is imported directly from the
glossary, so previous to this commit a nearly identical paragraph
is repeated.
For reference, the text imported from the glossasry is
> You can use finalizers to control garbage collection of resources.
> For example, you can define a finalizer to clean up related resources
> or infrastructure before the controller deletes the target resource.
while the text being removed in this commit is:
> You can use finalizers to control garbage collection of resources
> by alerting controllers to perform specific cleanup tasks before
> deleting the target resource.
2023-03-21 19:52:15 +01:00
3ca95d6c88
Tidy concepts pages within Label and Annotation
2023-02-19 16:30:51 +08:00
aa686a8d3a
Update content/en/docs/concepts/overview/working-with-objects/names.md
...
Co-authored-by: Qiming Teng <tengqm@outlook.com>
2023-02-16 13:01:19 +05:30
e2a33136c2
Update names.md
2023-02-16 08:10:47 +05:30
3fbb55b0db
Improve Lease concept ( #38307 )
...
* Improve Lease concept
* Write “heartbeat” consistently
(within Lease concept page).
2023-02-07 15:02:49 -08:00
ca3eefb13f
Update labels.md
...
negative matching 'notin' to match the example
2023-02-01 17:54:11 +05:30
60a4446b09
Tweak line wrappings in labels.md
2023-01-30 16:32:57 +08:00
1f612943ad
revert the previous changes for what's next session.
2023-01-18 12:53:53 +05:30
794f7bfb69
automatic labelling on namespaces stable since 1.22
2023-01-12 11:22:37 -05:00
5a637cdf4a
Merge pull request #37850 from Ritikaa96/updating-labels-and-selector-md
...
Updating labels.md
2023-01-03 01:09:34 -08:00
93df1ce57d
fix(common-labels): Specify SemVer version
2022-12-30 13:40:39 +07:00
93af2beccc
Updated Owners and Dependents page
2022-12-02 15:13:10 +05:30
fab0fc76a5
Updating labels.md
2022-11-28 11:42:38 +05:30
0efce181d5
Merge pull request #37892 from tamilselvan1102/k8s-doc-namespaces
...
added hyperlink for persistentVolumes in Namespaces page
2022-11-18 20:18:29 -08:00
05ae0c6bd7
Merge pull request #37869 from windsonsea/objecty
...
Use a consistent style of URLs and headings in /kubernetes-objects.md
2022-11-15 20:08:48 -08:00
a942fee552
added hyperlink for persistentVolumes in Namespaces page
2022-11-14 17:38:45 +05:30
2094e11386
Merge pull request #37739 from sftim/20221106_revise_namespaces_concept
...
Improve list of default namespaces
2022-11-13 18:29:57 -08:00
5d44f762aa
Merge pull request #37846 from Ritikaa96/updating-names-md
...
Adding annotations reference in names.md
2022-11-13 18:27:57 -08:00
25aa28ff6a
updated /kubernetes-objects.md
2022-11-13 21:31:24 +08:00
419d3b0d8e
added annotations in what's next sections
2022-11-11 18:22:45 +05:30
3607e97d2f
Replaced "Learn more about the following." with "Learn more about the following:" under whats next section.
2022-11-09 11:30:17 +05:30
761ea4c413
Rephrased the what's next section under kubernetes objects page.
2022-11-07 14:21:15 +05:30
6238ffa014
Added more points in what's next section of Understanding Kubernetes objects
2022-11-07 11:35:50 +05:30
8e7f06000f
Improve list of default namespaces
2022-11-06 08:47:52 +00:00
95683e0b2e
Change weight for localization correctness
...
Keeping index files weight as such. Also, no changes to the
card index as they are not needed.
Part of the work at Doc Sprint KubeCon NA 2022.
Related # #35093
Signed-off-by: Sahdev Zala <spzala@us.ibm.com>
2022-10-24 14:09:48 -04:00
6bfe72e2b0
update page weights for concepts overview working with objects
2022-10-24 11:52:44 -04:00
73aaba9b4e
Merge pull request #35810 from yilmi/created-by-deprecated
...
Removing created-by label deprecated since 1.9
2022-09-02 06:36:05 -07:00
e31d646d7c
Removing created-by label deprecated since 1.9
2022-08-22 19:21:57 +02:00
a180cd6853
Update docs to reference new container image registry
...
k8s.gcr.io is deprecated in favor of registry.k8s.io. The kubernetes
codebase have been updated with the new endpoint.
Ref: https://github.com/kubernetes/k8s.io/issues/3411
Signed-off-by: Arnaud Meukam <ameukam@gmail.com>
2022-08-18 16:35:26 +02:00
a9c9268c20
Merge pull request #33829 from eminalemdar/patch-2
...
Updated references in different pages with the correct titles
2022-07-10 19:19:47 -07:00
2f4a067fea
Batch fix links (4)
2022-07-06 09:43:15 +08:00
34721abcac
Use relative links for k8s.io
2022-06-30 12:08:14 +08:00
34155fed0b
Fix links for k/design-proposals-archive
...
The contributors/design-proposals in k/community was removed. It's only
available in k/design-proposals-archive repo now.
This commit also changes https://github.com/kubernetes/repo/blob/master/file.md
to https://git.k8s.io/repo/file.md for better consistency.
2022-06-10 22:49:04 +08:00
f559518520
Updated references in different pages with the correct titles of the documents
2022-05-19 17:00:59 +03:00
8d43e339b9
Fix wording for "concepts/overview/working-with-objects/kubernetes-objects/#required-fields"
2022-03-02 13:44:35 +00:00
63edc70641
Merge pull request #31639 from JayKayy/patch-1
...
Remove deprecated `--record` flag from example
2022-02-17 07:17:38 -08:00
fa4cc5965b
Update finalizers.md
2022-02-14 10:37:44 -05:00
0d9d83a23d
Remove deprecated `--record` flag from example
...
Trying to use this flag `--record` in the example leads to the warning:
```
Flag --record has been deprecated, --record will be removed in the future
```
2022-02-05 19:41:02 -05:00
61174c49ba
Add warning for creating namespaces with the same name as public TLDs
...
Uppercase Service API object following documentation style guide
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Add mitigation propositions
Add RFC reference for the trailing dot in an absolute DNS name
Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>
2022-01-27 10:58:41 +01:00
9117178a97
Namespace names must be RFC 1123 DNS labels
...
The how-to docs to create a new namespace already specify this, but I think it's worth mentioning in the overview doc that a namespace name must be an RFC 1123 label, as I didn't initially think to look in the how-to doc for limitations.
2022-01-13 12:10:06 -05:00
5a5b4d8a70
Comment YAML to specify excerpt
2022-01-11 10:33:07 +05:30
f6ae550af4
Add glossary_tooltip for StatefulSet
2022-01-11 10:26:58 +05:30
2342716d89
Merge branch 'main' into fix-link
2021-10-21 18:05:15 +08:00
d33605578f
Fix broken link in k8s.io/docs/concepts/overview/working-with-objects/finalizers/ ( #30159 )
...
* Fix broken link in finalizers.md
* Update finalizers.md
* Update finalizers.md
2021-10-20 16:56:08 -07:00
a6f27be7e1
Update content/en/docs/concepts/overview/working-with-objects/finalizers.md
...
Co-authored-by: Qiming Teng <tengqm@outlook.com>
2021-10-19 10:48:54 +08:00
b3ff003048
doc: accommodate re-write of intro line
2021-10-14 20:31:16 -04:00
86b6584d0a
doc: accept review suggestion
2021-10-14 20:25:30 -04:00
0ca22ac568
doc: update definition for namespaces
...
Update namespace definition to not use _Virtual Clusters_ as a means of explaining namespaces.
Motif: KubeCon NA 21 Talk on ***"Beyond Namespaces: Virtual Clusters are the Future of Multi-Tenancy - Lukas Gentele, Loft Labs"***
2021-10-14 15:06:29 -04:00
5c0dd0414b
remove blank
2021-10-09 10:50:09 +08:00
95a772fea7
fix link
2021-10-09 10:47:55 +08:00
5220cdf8d2
Explain leases in `kube-node-lease` namespace doc
...
Add a reference to `Lease` resource api doc
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-08-26 02:22:45 +02:00
497a5231df
Improve wording of `kube-node-lease` namespace doc
...
Correct grammar and provide a reference to more detailed documentation of concepts mentioned.
2021-08-25 17:20:22 +02:00
cdefcc3a8b
Merge pull request #29477 from brakmic/patch-1
...
trivial: typo
2021-08-19 20:39:24 -07:00
64f91d8e2c
add note on owner references in garbage collection page
...
add note on owner references to owner dependents page
2021-08-19 17:43:09 -07:00
2b268b1a76
trivial: typo
...
A small typo.
2021-08-19 22:07:59 +02:00
e47fba2b92
Fix typo
2021-08-06 07:46:25 -06:00
cba4f57124
Update link from Working With Objects to Kubernetes API Reference
2021-08-04 22:42:14 +01:00
651a0c2183
Amend the annotation concept
2021-07-28 11:30:35 +08:00
d078b427b8
Merge pull request #28870 from shannonxtreme/gc-docs
...
Create garbage collection docs
2021-07-26 22:40:45 -07:00
26748e36b0
Fix service name requirement
2021-07-25 19:57:50 +08:00
959d0c759b
Merge pull request #28738 from vaibhav2107/link-labels
...
Add the links in docs/concepts/overview/working-with-objects/labels/
2021-07-23 19:03:06 -07:00
b1573ad314
Create garbage collection docs
2021-07-13 20:32:50 +00:00
1f42a30967
Add the links in docs/concepts/overview/working-with-objects/labels/
2021-07-01 19:08:36 +05:30
5dfcf92490
Merge pull request #28447 from tengqm/fix-file-modes
...
Remove exec permission on markdown files
2021-06-17 19:04:04 -07:00
e9703497a1
Remove exec permission on markdown files
...
For some unknown reasons, we have got many markdown files with exec
permission. That is weird and risky.
2021-06-16 17:57:00 +08:00
bff31ff2b4
Correcting entry in Multiple Resource Types
...
We *can* use field selectors across multiple resource types.
2021-05-26 08:53:51 +05:30
50a5dbb21d
Fixes grammar typo
2021-05-07 16:08:57 -04:00
bca8c4b6e5
Add created by label ( #27612 )
...
* Add created by label
* Update content/en/docs/concepts/overview/working-with-objects/common-labels.md
2021-05-06 10:10:00 -07:00
08b8930751
Update content/en/docs/concepts/overview/working-with-objects/labels.md
...
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-04-22 06:59:44 -05:00
4f319fd5ab
Fix requirements for label value
...
Value *can* indeed be empty.
Fixes: bd55d498df
2021-04-20 13:43:29 -05:00
965aa51daf
Merge master into dev-1.21 to keep in sync, plus latest API reference
...
This sync merge includes API reference updates.
2021-04-06 21:38:24 +01:00
6c935b6f90
Improve docs for NamespaceDefaultLabelName
2021-04-01 21:43:47 +01:00
2d31364e3c
Merge pull request #26920 from SergeyKanzhelev/nameAsIdentifier
...
added note about the name being an identifier
2021-03-27 01:52:43 -07:00
3ff5ec1eff
clean up use of word: just
2021-03-17 19:57:40 -04:00
eb4b67d8a2
Update content/en/docs/concepts/overview/working-with-objects/names.md
...
Co-authored-by: Celeste Horgan <celeste@cncf.io>
2021-03-16 23:22:10 -07:00
6c60620ad4
added note about the name being an identifier
2021-03-06 06:42:50 +00:00
bd55d498df
Clarify requirements for label value syntax
2021-02-24 18:58:22 +01:00
3fd65482e8
clean up use of word: simply
2021-02-07 12:15:29 -05:00
7d9916af0c
clean up use of word: easy
2021-02-01 15:14:25 -05:00
c4b818c1f1
Update common-labels.md
2020-12-30 14:35:16 +05:30
8e0973b22b
Update md format to make it more easier to read
...
Before the changes, the statement of the set-values messed up together, so it is hard to read it out clearly.
2020-12-02 23:59:14 +08:00
070023b24a
Fix links in concepts section
2020-10-22 14:24:56 +08:00
3edb970570
Move API overview to be a Docsy section overview
2020-10-20 23:41:54 +01:00
dd88014f30
Remove statement about future of namespaces
2020-10-10 19:15:14 +01:00
c6a96128c4
Replace special quote characters with normal ones.
2020-08-11 21:05:22 +09:00
c8f4704873
Fix links in concepts section (2)
2020-08-02 09:11:14 +08:00
49eee8fd3d
Revise Pod concept ( #22603 )
...
* Revise Pod concept
Adapt the existing Pod documentation to suit the Docsy theme, by
promoting the Pod concept itself to /docs/concepts/workloads/pods/
Following on from this, update the Pod Lifecycle page to cover the
lifecycle of a Pod and follow on directly from the Pod concept,
for readers keen to understand things in detail.
This change also removes the automatic contents list from the Pod
overview page. Instead, the new page links to all the pages
inside the Pod section.
* Update links to Pod concept
Link to updated content
* Incorporate Pod concept suggestions
Co-authored-by: Celeste Horgan <celeste@cncf.io>
* Revise StatefulSet suggestion for Pod concept
Co-authored-by: Celeste Horgan <celeste@cncf.io>
Co-authored-by: Celeste Horgan <celeste@cncf.io>
2020-07-26 20:18:16 -07:00
9e0d6d8110
Merge pull request #22399 from rmauge/patch-1
...
Updates for minor spelling correction
2020-07-13 08:30:33 -07:00
f4d296d1c3
Fix the example values in the first examples
...
In the lower part of the document `instance` is derived from the `name` field. However, in the beginning of the document the value of the `instance` field is aligned with the `part-of` field. Which seems wrong, reading through the rest of the page.
Signed-off-by: Jens Reimann <jreimann@redhat.com>
2020-07-10 12:30:09 +02:00
52f2920d5f
Updates minor spelling correction
...
"can not" to "cannot"
2020-07-06 18:03:45 -04:00
86d373b0f9
Merge pull request #21997 from sftim/20200622_tidy_concepts_section_post_docsy
...
Tidy concepts section post-Docsy
2020-06-27 17:12:14 -07:00
de02f2f27d
Merge pull request #22054 from soltysh/kubectl_run_updates
...
Update kubectl run from docs where necessary
2020-06-26 14:30:14 -07:00
3ff7312cff
Add descriptions to Concept sections
...
Each section directly beneath Concepts gains a description.
2020-06-25 17:09:58 +01:00
00f502fa6a
Update kubectl run from docs where necessary
...
kubectl run starting from 1.18 is creating only Pods and there is no option to
create any other resource. Users should be using kubectl create
commands instead. This update the documentation in all those places
where kubectl create should be used instead or changes description to
reflect the situation.
2020-06-25 13:37:14 +02:00
d41074866e
Add a note about reserved namespace prefix
...
A namespace with prefix 'kube-' is reserved, even though k8s will let you create that
2020-06-23 18:10:41 -07:00
6cf2449a2e
add lease namespace new commit
2020-06-11 22:18:27 +01:00
ecc27bbbe7
add en pages
2020-06-09 19:33:15 -04:00
Tim Bannister
Kubernetes Prow Robot
Gabriel Reid
zhuzhenghao
Sajiyah Salat
Tim Bannister
Harikrishnan Mekkattu Pisharam Somarajan
windsonsea
lakshmi
Mathieu Benoit
Jai Govindani
Ritikaa96
Tamilselvan Thangamony
Michael
Sahdev Zala
Rey Lejano
Yassine Ilmi
Arnaud Meukam
Qiming Teng
Sean Wei
eminalemdar
Alexandru Gheorghe
Jordan Liggitt
John Kwiatkoski
mtardy
Adrian Ludwin
Anubhav Vardhan
Jizu Sun
sandipanpanda
Shabir Mohamed Abdul Samadh
shabirmean
Jizu Sun
naisu
Harris Brakmić
David M. Lentz
Shannon Kularathna
vaibhav
Alex
toshokan
Quentin Bisson
Mauricio Vásquez
Karen Bradshaw
Sergey Kanzhelev
veyu
AUT0R3V
ying
Qiming Teng
TAKAHASHI Shuuji
Jens Reimann
Raymond Maugé
Maciej Szulik
Rohit Mohta
cloudmelon