Skip to content

OKD: fix docs build and update OKD documentation #20627

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 31, 2020
Merged

OKD: fix docs build and update OKD documentation #20627

merged 1 commit into from
Mar 31, 2020

Conversation

vrutkovs
Copy link
Member

@vrutkovs vrutkovs commented Mar 21, 2020 •
edited
Loading

This fixes docs build using:

python3 build.py --distro openshift-origin --product "OKD" --version 4.4 --no-upstream-fetch && python3 makeBuild.py && asciibinder build -t 0

and updates OKD docs.

Fixes okd-project/okd#44
Fixes okd-project/okd#100
Fixes okd-project/okd#115
Fixes okd-project/okd#108

@openshift-ci-robot openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Mar 21, 2020
@vrutkovs vrutkovs force-pushed the okd-fcos-architecture branch from 201098d to 7979921 Compare March 21, 2020 13:08
@openshift-ci-robot openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 21, 2020
@vrutkovs vrutkovs force-pushed the okd-fcos-architecture branch 2 times, most recently from 4c59bf7 to ac53e6c Compare March 28, 2020 13:01
@vrutkovs vrutkovs changed the title WIP OKD: describe FCOS architecture OKD: fix docs build and update OKD documentation Mar 28, 2020
@openshift-ci-robot openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 28, 2020
@vrutkovs
Copy link
Member Author

vrutkovs commented Mar 28, 2020 •
edited
Loading

@mburke5678 @vikram-redhat PTAL

@vikram-redhat
Copy link
Contributor

@mburke5678 can you check it for correctness in terms of the ifdefs etc and making sure content bleed between distros doesn't occur.

@vrutkovs will need squashing of commits.

@vrutkovs
Copy link
Member Author

@vrutkovs will need squashing of commits.

Yeah, I'll do that once the reviewer is happy with the contents so that diffs could be tracked easier. Should I mark it WIP until then?

@LorbusChris
Copy link
Contributor

@mburke5678 ptal :)

@mburke5678
Copy link
Contributor

@vrutkovs @LorbusChris LGTM

@vrutkovs
Update OKD documentation
f079e90 
Change summary:
* _topic_map: include odo in openshift-origin distro
* _topic_map: include Helm in openshift-origin
* _topic_map: include Monitoring in openshift-origin
* modules/whats-new-features: update links to OLM and OperatorHub
* _topic_map: show Installation and Update for OKD
* installing/install_config/installing-customizing: hide FIPS section for OKD
* odc-creating-applications-using-developer-perspective: hide Serverless operator for OKD
* _topic_map: enable Release notes for OKD
* migration/migrating_3_4/planning-migration-3-to-4: hide Service Mesh reference for OKD
* Show FCOS in OKD documentation
* Use op-system-base and op-system-base-full to set OS base name
* modules/cli-installing-cli: use mirror.openshift.com to download oc on OKD
* cli_reference/openshift_cli/getting-started-cli: don't show "Installing the CLI by using an RPM" for OKD
* Hide RHEL workers from OKD docs
* _topic_map: hide IBM Z install for OKD
@vrutkovs vrutkovs force-pushed the okd-fcos-architecture branch from ac53e6c to f079e90 Compare March 30, 2020 20:12
@vrutkovs
Copy link
Member Author

Squashed in a single commit, ready for merge

mburke5678
mburke5678 reviewed Mar 31, 2020
View reviewed changes
modules/common-attributes.adoc
:op-system: FCOS
:op-system-base: Fedora
:op-system-base-full: Fedora
endif::[]
Copy link
Contributor

Choose a reason for hiding this comment

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

@openshift/team-documentation The OKD team has created some new variables for our docs to represent different operating systems. Vikram wanted me to announce these changes to you before I merge. Let me know if you have any concerns.

Copy link
Contributor

Choose a reason for hiding this comment

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

Only comment is to consider being consistent with the CoreOS attribute name by using op-system-base-first instead of op-system-base-full.

Copy link
Contributor

Choose a reason for hiding this comment

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

@vrutkovs I didn't see this comment ^^ until after I merged. Must have been a refresh issue. Any thoughts?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll include that in the next batch of updates

@mburke5678 mburke5678 added this to the Next Release milestone Mar 31, 2020
@mburke5678 mburke5678 merged commit 88033b5 into openshift:master Mar 31, 2020
@mburke5678
Copy link
Contributor

/cherrypick enterprise-4.5

@openshift-cherrypick-robot
Copy link

@mburke5678: #20627 failed to apply on top of branch "enterprise-4.5":

Using index info to reconstruct a base tree...
M	_topic_map.yml
M	applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc
M	installing/install_config/installing-customizing.adoc
M	migration/migrating_3_4/planning-migration-3-to-4.adoc
M	modules/cli-installing-cli.adoc
M	modules/common-attributes.adoc
M	modules/installation-overview.adoc
A	modules/whats-new-features.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): modules/whats-new-features.adoc deleted in HEAD and modified in Update OKD documentation. Version Update OKD documentation of modules/whats-new-features.adoc left in tree.
Auto-merging modules/installation-overview.adoc
Auto-merging modules/common-attributes.adoc
CONFLICT (content): Merge conflict in modules/common-attributes.adoc
Auto-merging modules/cli-installing-cli.adoc
Auto-merging migration/migrating_3_4/planning-migration-3-to-4.adoc
Auto-merging installing/install_config/installing-customizing.adoc
Auto-merging applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc
Auto-merging _topic_map.yml
CONFLICT (content): Merge conflict in _topic_map.yml
error: Failed to merge in the changes.
Patch failed at 0001 Update OKD documentation

In response to this:

/cherrypick enterprise-4.5

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@mburke5678 mburke5678 mentioned this pull request Jun 8, 2020
Merged
@vrutkovs vrutkovs deleted the okd-fcos-architecture branch September 16, 2020 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bergerhoffer bergerhoffer bergerhoffer left review comments

@mburke5678 mburke5678 mburke5678 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Next Release
7 participants
@vrutkovs @vikram-redhat @LorbusChris @mburke5678 @openshift-cherrypick-robot @bergerhoffer @openshift-ci-robot