Skip to content

Repo sync #39417

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.

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

Merged
merged 9 commits into from
Jul 21, 2025
Prev Previous commit
Next Next commit
Update GHES deprecation instructions with correct search hiding appro…
…ach (#56704)
  • Loading branch information
heiskr authored Jul 21, 2025
commit dcca53d2d4d07f579514a2964db9f42d8a804f3f
31 changes: 23 additions & 8 deletions src/ghes-releases/lib/deprecation-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,30 @@ All previously archived content lives in its own repository. For example, GHES 3

1. Update all translation directories to the latest `main` branch.

1. Hide search component temporarily while scraping docs in `src/search/components/Search.tsx`, by adding the `visually-hidden` class to the `form` element:
1. Hide search components temporarily while scraping docs by adding the `visually-hidden` class to the search components:

**In `src/search/components/input/SearchBarButton.tsx`**, wrap the return statement content:

```javascript
return (
<div data-testid="search">
<div className="position-relative z-2">
<form
role="search"
className="width-full d-flex visually-hidden"
<div className="visually-hidden">
{/* existing search button content */}
</div>
)
```

**In `src/search/components/input/SearchOverlayContainer.tsx`**, wrap the return statement content:

```javascript
if (isSearchOpen) {
return (
<div className="visually-hidden">
<SearchOverlay
// ... existing props
/>
</div>
)
}
```

1. Ensure your build is up to date:
Expand All @@ -93,7 +108,7 @@ All previously archived content lives in its own repository. For example, GHES 3
npm run deprecate-ghes-archive
```

1. Revert changes to `src/search/components/Search.tsx`.
1. Revert changes to `src/search/components/input/SearchBarButton.tsx` and `src/search/components/input/SearchOverlayContainer.tsx`.

1. Check in any change to `src/ghes-releases/lib/enterprise-dates.json`.

Expand Down Expand Up @@ -158,7 +173,7 @@ All previously archived content lives in its own repository. For example, GHES 3
1. Poke around several deprecated pages by navigating to `docs.github.com/enterprise/<DEPRECATED VERSION>`, and ensure that:
- Stylesheets are working properly
- Images are rendering properly
- The search functionality was disabled
- The search functionality was disabled during scraping
- Look at any console errors to ensure that no new unexpected errors were introduced. You can look at previous errors by viewing a previously completed deprecation page.
- You should see a banner on the top of every deprecated page with the date that the version was deprecated.
- You should see a banner at the top of every page for the oldes currently supported version with the date that it will be deprecated in the ~3 months.
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy