PaloAltoNetworks / PaloAltoNetworks/pan.dev
Issue/Cleanup code and documentation
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 78
- Forks
- 88
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 18
Description
Documentation link
Looks like there are a few places to cleanup the code and documentation by removing unnecessary console.logs and "TODO" comments.
- plugin-sitemap-coveo/src/index.cjs
- products/expedition/docs/managing_jobs.mdx
- products/expedition/docs/managing_expedition_agent.mdx
- products/expedition/docs/creating_credentials.mdx
Describe the problem
There are several places where stale information exists which clutters the page(s).
Suggested fix
Update the items and/or remove unnecessary comments or code.
(Working on my first PR to fix -- will update with a comment 😃
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review plugin-sitemap-coveo/src/index.cjs and the three listed Expedition MDX files, starting by locating the unnecessary console.logs, TODO comments, and stale information mentioned in the issue. Update or remove only those items, then verify that the documentation pages remain accurate and the cleanup is complete across all named files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100