Commit 26c82a2
authored
Remove duplicated CLI Options section (#678)
## Description
This PR fixes a bug in the docs where the "CLI options" section was
included twice.
This happened because [the original title-cased "CLI Options" header and
all other headers were modified to sentence-case in this
PR](#558) to match
[the docs style
guide](https://github.com/hashicorp/web-unified-docs/blob/main/docs/style-guide/general/titles-and-headings.md#use-sentence-case-for-titles-headings-and-navigation-labels).
The "CLI Options" header was in a section that should never be directly
edited because it is automatically generated by the update_website
Makefile target in the tfc-agent repo. Changing the casing of the header
in the docs repo directly make the update_website Makefile target not
work as expected. Instead of replacing the existing "CLI Options"
setting, it appended a new section because the header casing no longer
matched what was expected. The means the content under "CLI options" was
outdated and the content under "CLI Options" was the most up to date.
This PR cleans that up and makes the existing warning about not editing
this section a little easier to see. [I have a separate PR open to
update the header to sentence-casing directly in the tfc-agent
repo.](hashicorp/tfc-agent#1131)
## Screenshots
### Before
<img width="1098" height="325" alt="Screenshot 2025-08-01 at 3 23 59 PM"
src="https://github.com/user-attachments/assets/f23f3fbb-1867-4a71-8c30-ff1a90f502fa"
/>
### After
<img width="1093" height="332" alt="Screenshot 2025-08-04 at 4 01 00 PM"
src="https://github.com/user-attachments/assets/dfcfeb8d-10e7-43c5-ac06-effa1fc7c20e"
/>
## Related Links
1. [Jira
ticket](https://hashicorp.atlassian.net/browse/TFDN-1100?atlOrigin=eyJpIjoiOGRkMjk1YWI1NzJiNDhjYmJjNGZlODQ1ZTU5YzZmZmQiLCJwIjoiaiJ9)
2. [Related PR](hashicorp/tfc-agent#1131)File tree
1 file changed
+3
-143
lines changed- content/terraform-docs-agents/v1.23.x/docs/cloud-docs/agents
1 file changed
+3
-143
lines changedLines changed: 3 additions & 143 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
175 | 175 | | |
176 | 176 | | |
177 | 177 | | |
178 | | - | |
| 178 | + | |
| 179 | + | |
179 | 180 | | |
180 | 181 | | |
| 182 | + | |
181 | 183 | | |
182 | | - | |
183 | 184 | | |
184 | 185 | | |
185 | 186 | | |
| |||
314 | 315 | | |
315 | 316 | | |
316 | 317 | | |
317 | | - | |
318 | | - | |
319 | | - | |
320 | | - | |
321 | | - | |
322 | | - | |
323 | | - | |
324 | | - | |
325 | | - | |
326 | | - | |
327 | | - | |
328 | | - | |
329 | | - | |
330 | | - | |
331 | | - | |
332 | | - | |
333 | | - | |
334 | | - | |
335 | | - | |
336 | | - | |
337 | | - | |
338 | | - | |
339 | | - | |
340 | | - | |
341 | | - | |
342 | | - | |
343 | | - | |
344 | | - | |
345 | | - | |
346 | | - | |
347 | | - | |
348 | | - | |
349 | | - | |
350 | | - | |
351 | | - | |
352 | | - | |
353 | | - | |
354 | | - | |
355 | | - | |
356 | | - | |
357 | | - | |
358 | | - | |
359 | | - | |
360 | | - | |
361 | | - | |
362 | | - | |
363 | | - | |
364 | | - | |
365 | | - | |
366 | | - | |
367 | | - | |
368 | | - | |
369 | | - | |
370 | | - | |
371 | | - | |
372 | | - | |
373 | | - | |
374 | | - | |
375 | | - | |
376 | | - | |
377 | | - | |
378 | | - | |
379 | | - | |
380 | | - | |
381 | | - | |
382 | | - | |
383 | | - | |
384 | | - | |
385 | | - | |
386 | | - | |
387 | | - | |
388 | | - | |
389 | | - | |
390 | | - | |
391 | | - | |
392 | | - | |
393 | | - | |
394 | | - | |
395 | | - | |
396 | | - | |
397 | | - | |
398 | | - | |
399 | | - | |
400 | | - | |
401 | | - | |
402 | | - | |
403 | | - | |
404 | | - | |
405 | | - | |
406 | | - | |
407 | | - | |
408 | | - | |
409 | | - | |
410 | | - | |
411 | | - | |
412 | | - | |
413 | | - | |
414 | | - | |
415 | | - | |
416 | | - | |
417 | | - | |
418 | | - | |
419 | | - | |
420 | | - | |
421 | | - | |
422 | | - | |
423 | | - | |
424 | | - | |
425 | | - | |
426 | | - | |
427 | | - | |
428 | | - | |
429 | | - | |
430 | | - | |
431 | | - | |
432 | | - | |
433 | | - | |
434 | | - | |
435 | | - | |
436 | | - | |
437 | | - | |
438 | | - | |
439 | | - | |
440 | | - | |
441 | | - | |
442 | | - | |
443 | | - | |
444 | | - | |
445 | | - | |
446 | | - | |
447 | | - | |
448 | | - | |
449 | | - | |
450 | | - | |
451 | | - | |
452 | | - | |
453 | | - | |
454 | | - | |
455 | | - | |
456 | | - | |
457 | 318 | | |
458 | 319 | | |
459 | 320 | | |
| |||
469 | 330 | | |
470 | 331 | | |
471 | 332 | | |
472 | | - | |
0 commit comments